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

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

问题出在 workshop/side-quest-01-02-environment-reference.md。请阅读其中 "Before You Start" 的文字和 "Verify your tools are ready" 一节,然后检查 README.md 中的分支链接,以及 02a-setup-codespace.md 中的 Codespace 设置。完成的标准是:验证步骤要么以完成设置(或本地终端的 side quest)为前提,要么移到 02a,并且 "Before You Start" 的文字要说明这一点。运行 npx --yes markdownlint-cli2 "**/*.md" 以确认修改没有问题。

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

描述

Graph health summary

The generated report covered 97 pages, 338 constraints, 57 potential findings, 3 cycles, 3 feedback loops and 3 weird cycles. I checked the cited pages and confirmed one real ordering problem. The cycles and the 50 gh_authenticated "missing_prerequisite_link" findings are false positives (details below).

Mermaid graph (reduced to the pages involved in verified or cited anomalies; the full graph is in the generated report)
graph TD
  n01["01 Prerequisites"] --> n02a["02a Set Up a Codespace"]
  n01 -. branches .-> sq0102["01-SQ02 Environment Reference"]
  n01 -. branches .-> sq0201["02-SQ01 Local Terminal"]
  sq0201 -. fallback link .-> n02a
  n02a --> n05["05 What Are Agentic Workflows?"]
  n05 --> n05b["05b How Agentic Workflows Stay Safe"]
  n05b -. prerequisite .-> n05
  n05b --> n06["06 Install gh-aw"]
  n06 --> n07["07 Your First Workflow"]
  n07 --> n07d["07d Confirm Model Access"]
  n07 -. error recovery link .-> n07d
  n07d -. return link .-> n07
  n07d --> n08["08 Run Your Workflow"]
  n16["16 Connect Data Source"] -. links to .-> sq0102
Ordering constraints (key subset)
  • 01 -> 02a (or 02-SQ01 local path) -> 06 (install gh-aw) -> 07 -> 07d -> 08.
  • Every gh/gh aw command requires an opened Codespace or local terminal (environment_ready), which 02a or 02-SQ01 provides.
  • gh aw commands require the extension installed in 06.
  • 05b requires 05; 07d requires 07 (normal flow) or can precede it (model-access error recovery).
Confirmed cycles, feedback loops, weird cycles

All three are intentional and benign:

  • 07 <-> 07d: 07d documents two entry points (error recovery from 07, or the normal next step). Deliberate.
  • 05 <-> 05b: 05 only mentions 05b in inline prose ("You will explore security in..."). Only 05b lists 05 as a prerequisite, so this is not a real dependency loop.
  • 02a <-> 02-SQ01: the local-terminal side quest links back to 02a as a fallback ("switch to Set Up a Codespace"). This is an optional escape hatch, not a prerequisite.

The missing_prerequisite_link findings for gh_authenticated (about 50 pages) are heuristic noise: authentication is provided by the Codespace/gh setup in 02a/06 and is not a missing link per page.

Verified ordering problem

workshop/side-quest-01-02-environment-reference.md
  • Quoted 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, gh auth status

    (also the gh aw compile note: "the gh aw compile command still runs locally in your Codespace")

  • Missing earlier step: this side quest branches from 01-prerequisites.md (see README.md: "branches from Step 1"), and its Before You Start says "you can read it any time". But the Codespace (02a-setup-codespace.md) or local terminal (side-quest-02-01-local-terminal.md) does not exist yet at that point, and it also claims gh is "Pre-installed in the Codespace".

  • Why it confuses learners: a learner who follows the side quest from Step 1 is told to open a terminal "in your Codespace" and run verification commands before any Codespace has been created, and the page says no terminal is required to read it.

  • Suggested fix: in side-quest-01-02-environment-reference.md, either (a) change the "Verify your tools are ready" section to start with a conditional: "Once you have completed Set Up a Codespace (link unavailable: invalid HTTPS URL) (or the local terminal side quest), open a terminal and run:" or (b) move the verification block to 02a-setup-codespace.md, where the environment is first available. Also update the Before You Start text to say the verification block applies only after setup.

Notes

This issue is ready for an agent to resolve. Run npx --yes markdownlint-cli2 "**/*.md" after the edit, and assess golden-ticket branch impact (likely none: the page is a reference side quest).

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

  • expires on Nov 13, 2026, 12:01 PM UTC
主要语言
JavaScript
星标
62
派生
43
平均合并
1 天 5 小时
30 天内合并 PR
9

环境准备

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