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

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#5,331 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 3 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
85/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, javascript
Bereich
documentation

Rechercherichtung

Lies workshop/side-quest-01-02-environment-reference.md und vergleiche die Einrichtungsvoraussetzungen darin mit workshop/01-prerequisites.md, workshop/02a-setup-codespace.md und workshop/side-quest-02-01-local-terminal.md. Prüfe, wo die Anweisungen zur Terminalüberprüfung und zu gh aw compile erscheinen. Erledigt, wenn Lernende die Referenzseite vor der Einrichtung lesen können, ohne dazu aufgefordert zu werden, Befehle auszuführen, die sie noch nicht verwenden können.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Summary

Reviewed 97 workshop pages (338 edges, 338 constraints, 57 potential findings, 3 cycles, 3 feedback loops, 3 weird cycles). After checking the cited files, one real ordering problem is confirmed. The rest are heuristic false positives.

The full generated graph and constraint list are too large to inline (338 edges). They are in the workflow artifact order-review-report.md. Below is the condensed main-path graph, which is a linear chain:

graph TD
  W00["00 welcome"] --> P01["01 prerequisites"]
  P01 --> S02a["02a setup codespace"]
  P01 -.before.-> SQ0201["side-quest 02-01 local terminal"]
  S02a --> S04["04 actions intro"]
  SQ0201 --> S04
  S04 --> S05["05 agentic 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 workflow"]
  P01 -.branch.-> SQ0102["side-quest 01-02 environment reference"]

Ordering constraints (main path)

  • 01 → 02a (or the 02-01 local terminal side quest) → 04 → 05 → 05b → 05c → 06 → 07 → 07d → 08
  • 02a / 02-01 provide environment_ready, gh_installed and gh_authenticated for everything from 06 onward.
  • 06 must come before any gh aw command (07 onward).
  • 07 requires 06 (gh aw init already run).
  • 07d: optional recovery branch from 07, or normal next step after 07.

Cycles, feedback loops, weird cycles

All three reported pairs were checked and are not real ordering problems:

  • 07 ↔ 07d: 07d deliberately documents two arrival paths ("Arriving from step 07 (error recovery)" and "Arriving as the next step after step 07 (normal flow)"). It is an intentional error-recovery loop and each path is clearly labeled.
  • 05 ↔ 05b: 05 only mentions 05b inline ("You will explore security in ...") and ends with **Next:**. 05b lists 05 as a prerequisite. This is a forward reference, not a prerequisite cycle.
  • 02a ↔ side-quest-02-01: These are alternative setup paths. The capability edges both ways are artifacts of the heuristic. The side quest sends learners to 02a only as a fallback.

The 49 missing_prerequisite_link findings on conceptual pages (e.g. 05-agentic-workflows-intro.md) were not confirmed. Those pages use gh aw only as a concept, with no commands the learner must run.

Verified ordering problem

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

  • Quoted instruction (too early): "Open a terminal in your Codespace and run: gh --version / git --version" (under "Verify your tools are ready"). Earlier, the Before You Start says "No terminal required to read this page", but the checkpoint then asks for terminal commands.

  • Missing prerequisite: This side quest branches from Step 1 (01-prerequisites.md), before 02a-setup-codespace.md or side-quest-02-01-local-terminal.md has opened a Codespace or local terminal. The page also tells the learner "gh ... Pre-installed in the Codespace" and references gh aw compile, which does not exist until Step 6.

  • Why it confuses or blocks: A learner who takes this side quest right after Step 1 has no Codespace yet. They cannot "open a terminal in your Codespace", and a failed gh --version check points them back to 02a, creating a backwards loop.

  • Suggested fix:

    1. Change the Before You Start to say the verification section needs the environment from Set Up a Codespace (link unavailable: invalid HTTPS URL) (or the local terminal side quest), and that the reading portion does not.
    2. Move "Verify your tools are ready" behind a note such as "Do this after completing Step 2" or make the checkpoint item conditional ("If you have already set up your environment...").
    3. Make the "Starting at Step 6" and gh aw compile mentions descriptive only, not instructions to run.
    4. Optionally update the README entry ("branches from Step 1") to say "read any time; verification after Step 2".

Note

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 5, 2026, 11:03 AM UTC
Vorherrschende Sprache
JavaScript
Sterne
58
Forks
40
Ø Merge
4 T. 4 Std.
Gemergte PRs (30 T.)
8

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

  • Kein Dockerfile und keine Docker-Compose-Datei
  • Keine Pull-Request-Vorlage
  • Kein Beitragsleitfaden

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus githubnext/gh-aw-workshop

Alle Issues in githubnext/gh-aw-workshop

Ähnliche Issues

Weitere Issues zu JavaScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.