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

オープン 初心者向け
  • 何か問題がありますか？
#5,282 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
70/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github, github-actions
領域
documentation

調査の方向性

問題は workshop/side-quest-01-02-environment-reference.md の「Verify your tools are ready」セクションにあり、Codespace のターミナルが存在することを前提としています。順序のずれを確認するため、workshop/02a-setup-codespace.md および「Before You Start」セクションと比較してください。完了条件は、セクションが最初に必要なセットアップ手順を示すこと、用語集がターミナルなしでも読めること、そして npx --yes markdownlint-cli2 "**/*.md" が成功することです。

索引モデルが issue の本文から書いたものです。

説明

Summary

The generated report covered 97 workshop pages, 338 constraints, 57 potential findings, and 3 cycles/feedback loops/weird cycles. I checked the cited files. One ordering problem is real and small. The other findings are heuristic false positives.

The full 97-node graph and all 338 constraints are in the run's generated report (order-review-report.md). The condensed core path is below.

Mermaid graph (core path)

graph TD
  W00["00 Welcome"] --> P01["01 Prerequisites"]
  P01 --> S02a["02a Set Up a Codespace"]
  P01 -.branch.-> SQ0102["01-SQ02 Environment Reference (side quest)"]
  P01 -.branch.-> SQ0201["02-SQ01 Local Terminal (side quest)"]
  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 --> S08["08 Run your workflow"]
  S07 -.error recovery.-> S07d
  S07d -.return.-> S07

Ordering constraints (core)

  • 00 → 01 → 02a (or 02-SQ01 local path) → 04 → 05 → 05b → 05c → 06 → 07 → 07d → 08 → ...
  • 02a (or 02-SQ01) provides environment_ready, gh_installed and gh_authenticated. Every page that uses gh or gh aw depends on these.
  • 06 provides the gh aw extension. 07 and later depend on it.
  • 05 and 05b are linked in both directions: 05 links forward to 05b, and 05b lists 05 as a prerequisite.
  • 07 and 07d are linked in both directions: 07d serves as an error-recovery page and as the normal next step.

Cycles, feedback loops and weird cycles

All three are false positives:

  • 05 ↔ 05b: 05 mentions 05b ("You will explore security in...") and 05b requires 05. That is a forward reference plus a prerequisite, not a real cycle.
  • 07 ↔ 07d: 07d-confirm-model-access.md documents two entry points on purpose ("Arriving from step 07 (error recovery)" and "Arriving as the next step after step 07 (normal flow)"). This is intentional.
  • 02a ↔ 02-SQ01: these are alternative setup paths (Codespace vs. local terminal). They are not sequential dependencies.

The 49 missing_prerequisite_link findings for gh_authenticated come from the heuristic. Mentions of gh aw compile in 05, side-quest-05-03 and similar pages are descriptive text. In 06 onward the "Before You Start" sections correctly point to the Codespace setup. I am not treating them as defects.

Verified ordering problem

Environment Reference asks learners to open a Codespace terminal before the Codespace setup

  • File reviewed: workshop/side-quest-01-02-environment-reference.md (a side quest that branches from Step 1, 01-prerequisites.md, which comes before 02a-setup-codespace.md)

  • Quoted instructions that appear too early:

    • "Open a terminal in your Codespace and run:" followed by gh --version and git --version
    • "If either fails, see Set Up a Codespace (link unavailable: invalid HTTPS URL)."
    • The glossary row says gh is "Pre-installed in the Codespace".

  • Missing earlier step: 02a-setup-codespace.md (or side-quest-02-01-local-terminal.md) creates the terminal environment this section assumes. The page's own "Before You Start" says "No terminal required to read this page". The page is also linked from Step 1 and from Step 6/16 content, so learners can reach it before any Codespace exists.

  • Why it confuses or blocks learners: A learner who arrives from Step 1 is told to open a Codespace terminal that does not exist yet. The verify checks fail or can't be run, and the fix link points forward.

  • Suggested fix: Reword the "Verify your tools are ready" section to say "After you finish Set Up a Codespace (link unavailable: invalid HTTPS URL) (or the local terminal side quest), open its terminal and run...". Add that prerequisite to "Before You Start" for the verification part only. Keep the glossary readable without a terminal. Optionally move the gh aw verification block under "after Step 6".

Notes

  • The issue is ready for an agent to resolve.
  • Run npx --yes markdownlint-cli2 "**/*.md" after editing.
  • Check whether the golden-ticket-workshop branch needs a matching change.

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

  • expires on Nov 3, 2026, 6:05 PM UTC
主要言語
JavaScript
スター
56
フォーク
40
平均マージ
2日 14時間
マージ済み PR（30日）
13

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

githubnext/gh-aw-workshop のほかの issue

githubnext/gh-aw-workshop の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。