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

Aperta Adatta ai principianti
  • Qualcosa non va?
#5,269 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
62/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github, github-actions, markdown
Ambito
documentation

Direzione di ricerca

L'affermazione si trova alla riga 20 di workshop/18-share-and-reuse.md, e l'esempio alla riga 76 usa la forma in tre parti gh aw add. Esegui gh aw add --help e verifica se .github/workflows/ viene risolto come posizione abbreviata prima di modificare. È completato quando la pagina indica la directory che la forma abbreviata cerca effettivamente, oppure mostra il percorso esplicito in quattro parti o l'URL blob per i file di .github/workflows/.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
JavaScript
Stelle
56
Fork
40
Merge medio
2g 14h
PR unite (30g)
13

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

  • Nessun Dockerfile né file Docker Compose
  • Nessun modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di githubnext/gh-aw-workshop

Tutte le issue di githubnext/gh-aw-workshop

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.