[ordering-review] workshop order graph: 1 confirmed ordering problem, 3 benign cycles

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

从 workshop/05-agentic-workflows-intro.md 第 53 行附近开始,活动 1 在这里要求学习者打开一个尚不存在的 .lock.yml 文件,并查看 workshop/07-your-first-workflow.md,确认第一次编译发生在哪里。完成意味着学习者在步骤 05 不会再遇到缺失文件,要么指向一个示例 lock 文件,要么把该活动移到步骤 07 之后,并相应改写检查点。

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

描述

Graph health summary

Reviewed 98 workshop pages (3 dispatcher/informational), 346 edges and 59 heuristic findings. After checking the cited files, 1 real ordering problem is confirmed. The 3 reported cycles are benign navigation loops. Most of the 50 missing_prerequisite_link findings are false positives: they come from concept or reference pages that mention gh aw compile without asking the learner to run it.

Mermaid graph (core spine, simplified)

The full 98-node graph is in the generated order-review-report.md artifact.

graph TD
  W00[00 welcome] --> P01[01 prerequisites]
  P01 --> S02a[02a setup codespace]
  P01 -.alt.-> SQ0201[02-SQ01 local terminal]
  SQ0201 -.fallback.-> S02a
  S02a --> S04[04 Actions intro]
  SQ0201 --> S04
  S04 --> S05[05 agentic workflows intro]
  S05 --> S05b[05b security]
  S05b --> S05c[05c practice]
  S05c --> S06[06 install gh-aw]
  S06 --> S07[07 first workflow]
  S07 --> S07d[07d confirm model access]
  S07d -.return on error.-> S07
  S07 --> S08[08 run workflow]
  S08 --> S08b[08b interpret run]
  S08b --> S09[09 agentic editing]

Ordering constraints (key ones)

  • 01 prerequisites → 02a setup codespace (or 02-SQ01 local terminal) → 04 → 05 → 05b → 05c → 06 install gh-aw → 07 → 08 → 08b → 09
  • 02a or 02-SQ01 must provide environment_ready, gh_installed and gh_authenticated before any gh or gh aw command.
  • 06 must provide gh-aw before 07 (gh aw init, gh aw compile) and 08 (gh aw run).
  • 07 → 07d (model access) with an explicit return link to 07.

Cycles, feedback loops, weird cycles

All three are reported identically as cycle, feedback loop and weird cycle. None need a fix.

  1. 07-your-first-workflow ↔ 07d-confirm-model-access is intentional error recovery. 07d says "Arriving from step 07 (error recovery)... then return to Write Your First Agentic Workflow."
  2. 05-agentic-workflows-intro ↔ 05b-agentic-workflows-security is a mutual before/next pair. 05b requires 05, and 05 continues to 05b. The before edge back to 05 is only a "read first" prerequisite, so there is no real loop.
  3. 02a-setup-codespace ↔ side-quest-02-01-local-terminal are alternative setup paths that link to each other as fallbacks, not a circular dependency.

Verified ordering problem

1. Lock-file activity before any workflow exists
  • File reviewed: workshop/05-agentic-workflows-intro.md
  • Instruction that appears too early (line 53): "Activity 1 — identify the parts: Open any .lock.yml file in your repo and find the on: key." The code block below it says # Example: open .github/workflows/my-workflow.lock.yml. Checkpoint item: "You identified the on: key in a compiled .lock.yml file".
  • Missing prerequisite: The learner's practice repository has no .lock.yml at this point. Nothing in 01–04 creates one. 06-install-gh-aw.md installs gh-aw, and 07-your-first-workflow.md is where daily-report-status.lock.yml is first compiled.
  • Why it confuses or blocks: The learner is told to open a file that does not exist yet and must tick a checkpoint item they cannot complete. They may stop, think their setup is broken, or skip the activity.
  • Suggested fix: Either (a) change Activity 1 to point at a sample or embedded snippet in the page, or at the workshop repository's published example lock file, and reword the checkpoint to match; or (b) move the "open the .lock.yml and find on:" activity to the end of 07-your-first-workflow.md, after the first compile, and keep step 05 conceptual.
Reviewed and not flagged
  • side-quest-01-02-environment-reference.md: the page says "No terminal required to read this page." The gh --version check is an optional checkpoint, and the page notes the tools are in the Codespace. This is a reference side quest, not an ordering break.
  • Other missing_prerequisite_link items (05-SQ03, 08b, 09, 11-x, 13-x, 17-x and later): these are conceptual or reference pages, or later steps that sit after 06 and 07 in the main path, so gh aw is already available.

This issue is ready for an agent to resolve.

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

  • expires on Nov 21, 2026, 10:44 PM UTC
主要语言
JavaScript
星标
61
派生
43
平均合并
10 小时 38 分钟
30 天内合并 PR
12

环境准备

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