[workshop-sync] workshop/18-share-and-reuse.md: `gh aw add` shorthand lookup location unclear

Closed Beginner friendly
#5,269 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 3 days

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
github, github-actions, markdown
Domain
documentation

Research direction

The claim is on line 20 of workshop/18-share-and-reuse.md, and the example on line 76 uses the three-part gh aw add form. Run gh aw add --help and test whether .github/workflows/ resolves as a shorthand location before editing. Done when the page either names the directory the shorthand actually searches or shows the explicit four-part path or blob URL for .github/workflows/ files.

Written by the indexing model from the issue text.

Description

documentation

Workshop file reviewed

workshop/18-share-and-reuse.md

Problem

Line 20 says:

Any .md file in a .github/workflows/ folder of a repository you have read access to can act as a template

and line 76 shows gh aw add jsmith/my-workshop/daily-status.

The live gh aw add help (gh-aw v1.0.1) says the three-part form is owner/repo/workflow-name[@version] and "implicitly looks in workflows/ directory". It doesn't mention .github/workflows/ as the shorthand lookup location, so the page's claim is not supported by the CLI help.

Suggested fix

Clarify where the shorthand resolves. Either say the template should live in workflows/ for the shorthand to work, or show the explicit four-part form (owner/repo/workflows/workflow-name.md[@version]) or a full GitHub blob URL for files in .github/workflows/. Verify the actual behavior with gh aw add --help and a test before editing.

Files 19 (19-research-driven-training-node.md) and 20 (20-persistent-memory.md) were also reviewed with no issues found. Two external links (reusing-workflows, compilation-process) could not be checked against the doc URL map.

Generated by 🔍 Workshop Sync Check · copilot · auto · ~54 AIC · ⌖ ~1 AIC · ⊞ 4.7K · ◷

  • expires on Nov 3, 2026, 11:28 AM UTC
Dominant language
JavaScript
Stars
58
Forks
40
Avg merge
4d 4h
Merged PRs (30d)
8

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

  • No Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/gh-aw-workshop

All issues in githubnext/gh-aw-workshop

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.