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

已关闭 适合新手
#5,269 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
62/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
github, github-actions, markdown
领域
documentation

调研方向

该说法位于 workshop/18-share-and-reuse.md 第 20 行,第 76 行的示例使用了三段式的 gh aw add 形式。运行 gh aw add --help,并在编辑之前测试 .github/workflows/ 是否会被解析为简写位置。当页面要么写明简写形式实际搜索的目录,要么给出 .github/workflows/ 文件的显式四段式路径或 blob URL 时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

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
主要语言
JavaScript
星标
58
派生
40
平均合并
4 天 4 小时
30 天内合并 PR
8

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

githubnext/gh-aw-workshop 的其他 Issue

查看 githubnext/gh-aw-workshop 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。