[ordering-review] workshop order graph: 1 side-quest ordering issue, 3 benign cycles

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

阅读 workshop/side-quest-01-02-environment-reference.md 和 workshop/README.md,确认 side quest 从哪里分支,以及何时进行 Codespace 设置。更新验证说明,让学习者知道应在完成 Codespace 设置后运行检查;如果合适,也调整 README 中关于分支的说明。当明确告知在设置前跟随 side quest 的学习者,在拥有 Codespace 之前应将此页面视为参考资料时,即为完成。

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

描述

Graph health summary

Reviewed 98 pages (3 dispatcher pages), 346 edges, 59 heuristic findings, 3 cycles, 3 feedback loops and 3 weird cycles. After verifying the cited pages, 58 findings are false positives (details below). One real ordering problem remains. The full generated graph and constraint list are in order-review-report.md from the run artifacts. The condensed core path is below.

graph TD
  w00["00 welcome"] --> p01["01 prerequisites"]
  p01 --> s02a["02a setup codespace"]
  p01 -.->|branch| sq0102["01-SQ02 environment reference"]
  p01 -.->|branch| sq0201["02-SQ01 local terminal"]
  s02a --> a04["04 actions intro"]
  sq0201 --> a04
  a04 --> a05["05 agentic intro"]
  a05 --> a05b["05b security"]
  a05b --> a05c["05c practice"]
  a05c --> i06["06 install gh-aw"]
  i06 --> f07["07 first workflow"]
  f07 --> m07d["07d model access"]
  m07d --> r08["08 run workflow"]
  r08 --> r08b["08b interpret run"]
  r08b --> e09["09 agentic editing"]

Ordering constraints (key ones)

  • 01 → 02a (Codespace) or 02-SQ01 (local) → 04 → 05 → 05b → 05c → 06 → 07 → 07d → 08 → 08b → 09
  • environment_ready, gh_installed and gh_authenticated are provided by 02a (or 02-SQ01).
  • gh aw commands require 06 (extension installed) and 07's gh aw init.
  • 05/05b and 07/07d have reciprocal before/next edges (see cycles).

Cycles, feedback loops and weird cycles

All three are benign:

  1. 05 ↔ 05b – 05b says "You've read What Are Agentic Workflows?" and 05 says "Next: How Agentic Workflows Stay Safe". This is a normal prev/next pair, not a loop.
  2. 07 ↔ 07d – 07d deliberately has two entry points (error recovery from 07, or the normal next step), and 07 links to it for troubleshooting. This is documented intentionally.
  3. 02a ↔ 02-SQ01 – these are alternative environment paths (Codespace vs local) that reference each other as options, not a sequential loop.

The 51 missing_prerequisite_link findings (gh_authenticated not linked to 02a on later steps) are heuristic false positives. All those pages sit after 02a and 06 in the linear path, and 06/07 already state the prerequisites.

Verified ordering problem

File: workshop/side-quest-01-02-environment-reference.md

Instruction that appears too early (section "Verify your tools are ready"):

Open a terminal in your Codespace and run:
gh --version / git --version / gh auth status

Missing earlier step: The side quest branches from Step 1 (link unavailable: invalid HTTPS URL) (per workshop/README.md), but the Codespace is not created until 02a-setup-codespace.md. The page's own "Before You Start" says "No terminal required", yet the checkpoint section asks learners to open a Codespace terminal and run gh/gh auth status. It also says "If any command fails, see Set Up a Codespace", which points forward to a step the learner may not have done.

Why it confuses learners: A learner who follows the side quest right after Step 1 has no Codespace or terminal to open, so the verification looks broken or leads them to skip the check.

Suggested fix:

  • Change the intro to: "Do this verification after you finish Set Up a Codespace (link unavailable: invalid HTTPS URL); until then, treat this page as read-only reference."
  • Replace "Open a terminal in your Codespace and run:" with "After completing Set Up a Codespace, open its terminal and run:".
  • Optionally move the README branch note to "branches from Step 2a".

This issue is ready for an agent to resolve.

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

  • expires on Nov 17, 2026, 11:07 AM UTC
主要语言
JavaScript
星标
62
派生
43
平均合并
11 小时 26 分钟
30 天内合并 PR
13

环境准备

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