[ordering-review] workshop order graph: 1 confirmed ordering issue, 3 cycles reviewed as false positives

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1-3 小时
新手友好度
87/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
活跃
技术栈
markdown
领域
documentation

调研方向

阅读 workshop/side-quest-01-02-environment-reference.md,并检查它在 workshop/README.md 中的条目,以了解学习者何时会到达该页面。将工具验证说明设为仅在完成设置后执行,或将其移至 workshop/02a-setup-codespace.md;gh aw --version 的说明继续以 Step 6 为前提。运行 npx --yes markdownlint-cli2 "**/*.md",并检查 golden-ticket-workshop 是否需要相应更改。

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

描述

Graph health summary

The heuristics covered 97 workshop files, 97 nodes, 338 edges and 57 potential findings. I checked the cited files and confirmed 1 real ordering problem. The other findings are false positives or intentional structure (details below).

Mermaid graph (core path and reviewed pairs)

The full generated graph is in the workflow's order-review-report.md. This condensed version shows the core path and the pairs I reviewed.

graph TD
  W00["00-welcome"] --> P01["01-prerequisites"]
  P01 --> S02a["02a-setup-codespace"]
  P01 -.branches.-> SQ0102["side-quest-01-02-environment-reference"]
  S02a --> S04["04-github-actions-intro"]
  S04 --> S05["05-agentic-workflows-intro"]
  S05 --> S05b["05b-agentic-workflows-security"]
  S05b --> S05c["05c-practice"]
  S05c --> S06["06-install-gh-aw"]
  S06 --> S07["07-your-first-workflow"]
  S07 --> S07d["07d-confirm-model-access"]
  S07d -.error recovery back to.-> S07
  S07d --> S08["08-run-your-workflow"]
  S08 --> S08b["08b-interpret-your-run"]
  S08b --> S09["09-agentic-editing"]
  S02a <-.alternative path.-> SQ0201["side-quest-02-01-local-terminal"]

Ordering constraints (key ones)

  • 00-welcome → 01-prerequisites → 02a-setup-codespace (explicit next links)
  • 02a-setup-codespace (or side-quest-02-01-local-terminal) must come before any step that needs environment_ready, gh_installed or gh_authenticated
  • 05-agentic-workflows-intro → 05b-agentic-workflows-security
  • 06-install-gh-aw → 07-your-first-workflow → 07d-confirm-model-access → 08-run-your-workflow
  • The other 330 or so constraints are in the generated report.

Cycles, feedback loops and weird cycles

All three reported cycles are false positives or intentional:

  1. 07-your-first-workflow ↔ 07d-confirm-model-access is an intentional error-recovery loop. 07d documents "two entry points": arriving from step 07 on a model-access error, and arriving as the normal next step. The loop does not block a learner.
  2. 05-agentic-workflows-intro ↔ 05b-agentic-workflows-security comes from a duplicate "next" link plus a "Before You Start" back-reference. The order is linear (05 → 05b), so this is not a real cycle.
  3. 02a-setup-codespace ↔ side-quest-02-01-local-terminal are alternative setup paths. The side quest links back to 02a only as a fallback ("switch to Set Up a Codespace"). It is not a dependency loop.

The 40 or so missing_prerequisite_link findings (for example 07, 08 and 09 lacking a link to 02a for gh_authenticated) are heuristic noise. They are satisfied transitively by the linear path through 06 and 07.

Verified ordering problem

side-quest-01-02-environment-reference.md
  • File reviewed: workshop/side-quest-01-02-environment-reference.md. It is listed in workshop/README.md as branching from Step 1 (link unavailable: invalid HTTPS URL), before 02a.
  • Instruction that appears too early: "### :white_check_mark: Verify your tools are ready — Open a terminal in your Codespace and run: gh --version / git --version". The page also says: "If either fails, see Set Up a Codespace (link unavailable: invalid HTTPS URL)."
  • Missing prerequisite: A learner reaching this side quest from Step 1 has not yet done 02a-setup-codespace.md or the local-terminal path, so there is no Codespace terminal to open.
  • Why it could confuse or block a learner: The Before You Start section says "No terminal required to read this page", but the checkpoint and verify section tell the learner to open a terminal in a Codespace they may not have created. The same page also links to a later step (Step 6) and mentions gh aw --version.
  • Suggested fix: In side-quest-01-02-environment-reference.md, make the "Verify your tools are ready" section conditional. For example, add "If you have already completed Set Up a Codespace (link unavailable: invalid HTTPS URL), open a terminal and run...", and tell learners who haven't to come back after Step 2. Alternatively, move the verify commands and the related checkpoint item out of the reference page and into 02a-setup-codespace.md. Keep the existing gh aw --version note gated on Step 6.

Next step

This issue is ready for an agent to resolve. Edit the one workshop file above, run npx --yes markdownlint-cli2 "**/*.md", and check whether golden-ticket-workshop needs a matching change.

Generated by 🧭 Workshop Order Review · copilot · auto · ~24 AIC · ⌖ ~1 AIC · ⊞ 4.8K · ◷

  • expires on Nov 10, 2026, 12:02 AM UTC
主要语言
JavaScript
星标
58
派生
40
平均合并
1 天 22 小时
30 天内合并 PR
7

环境准备

在 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 摘要。