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

Offen Anfängerfreundlich
#6,010 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
85/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github
Bereich
documentation

Rechercherichtung

Öffne workshop/side-quest-01-02-environment-reference.md und lies den Abschnitt „Before You Start“ sowie den Checkpoint „Verify your tools are ready“, den er zitiert. Vergleiche mit workshop/02a-setup-codespace.md und workshop/side-quest-02-01-local-terminal.md, um die korrekten relativen Links zu ermitteln, da das Issue den Codespace-Link als ungültig meldet. Formuliere den Checkpoint in „Nachdem du Schritt 2 abgeschlossen hast…“ um und führe die Setup-Seiten als Voraussetzungen vor den Befehlen auf. Erledigt ist die Aufgabe, wenn die Seite einem Leser von Schritt 1 nicht mehr sagt, ein Terminal zu öffnen, das es noch nicht gibt, und die Prüfung gh aw --version bis Schritt 6 zurückgestellt bleibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Graph health summary

Reviewed 98 workshop pages (346 constraints, 59 heuristic findings, 3 cycles/feedback loops/weird cycles). Verified findings against the cited files. 1 real ordering problem was confirmed. The other 58 findings and all three cycles are false positives or intentional (see below).

Mermaid graph (core path, condensed from the full 98-node report)

graph TD
  W["00 Welcome"] --> P["01 Prerequisites"]
  P --> C["02a Set Up a Codespace"]
  P -.alt.-> L["02-SQ01 Local Terminal"]
  C --> A4["04 Actions intro"]
  L --> A4
  A4 --> A5["05 Agentic intro"]
  A5 --> A5b["05b Security"]
  A5b --> A5c["05c Practice"]
  A5c --> I["06 Install gh-aw"]
  I --> F["07 First workflow"]
  F --> M["07d Confirm model access"]
  F -.error recovery.-> M
  M -.return.-> F
  M --> R["08 Run"]
  R --> R2["08b Interpret"]
  R2 --> E["09 Agentic editing"]
  P -.side quest.-> ER["01-SQ02 Environment Reference"]
  ER -. "gh --version / gh auth status" .-> C

Ordering constraints (key ones)

  • 01 Prerequisites → 02a (or 02-SQ01) environment ready (terminal, git, gh, gh auth) → 04 → 05 → 05b → 05c
  • Environment ready + authenticated gh → 06 install gh-aw → 07 (gh aw init, gh aw compile) → 07d → 08 (gh aw run) → 08b → 09 onward
  • Every page using gh aw ... requires 06 to be complete first (all verified pages link to 06 or are downstream of it).

Cycles / feedback loops / weird cycles

  • 07-your-first-workflow.md ↔ 07d-confirm-model-access.md: intentional. 07d documents both entry points (error recovery from 07, and normal next step), and 07 links to it only for troubleshooting.
  • 05-agentic-workflows-intro.md ↔ 05b-agentic-workflows-security.md: false positive. 05 → 05b is the real next link; 05b only lists 05 as a read prerequisite.
  • 02a-setup-codespace.md ↔ side-quest-02-01-local-terminal.md: intentional. These are mutually exclusive alternative setup paths that link to each other as fallbacks.

Verified ordering problem

1. Environment Reference tells learners to use a Codespace terminal before one exists
  • File reviewed: workshop/side-quest-01-02-environment-reference.md (branches from Step 1; linked from workshop/README.md; also reachable before 02a-setup-codespace.md)

  • Quoted instruction 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"

    and the glossary row "GitHub CLI (gh) ... Pre-installed in the Codespace."

  • Missing prerequisite: The page declares itself readable "any time" and branches from Step 1, but the Codespace (or local terminal) is only created in 02a-setup-codespace.md / side-quest-02-01-local-terminal.md. The "Before You Start" section never points to those pages, and the failure fallback ("If any command fails, see Set Up a Codespace") is placed after the commands.

  • Why it confuses learners: A learner arriving from Step 1 is told to open a Codespace terminal that does not exist yet and to run gh/gh auth status checks, which will fail or be impossible.

  • Suggested fix: In "Before You Start", state that the verification checkpoint requires completing Set Up a Codespace (link unavailable: invalid HTTPS URL) (or the local terminal side quest) first, and reword the checkpoint intro to "After you finish Step 2, open the terminal in your Codespace or local terminal and run:". Keep the gh aw --version check deferred until after Step 6, as already noted.

Dismissed findings

  • 57 missing_prerequisite_link findings (gh_authenticated not linked to 02a/02-SQ01/06-SQ01/06-SQ02/enterprise setup) for pages from 05-agentic-workflows-intro.md onward: these are downstream of Steps 2 and 6 in the linear path (07 explicitly links to Step 6 and states gh aw must already work); 05, 05-SQ03 and similar only mention gh aw compile conceptually. side-quest-02-01-local-terminal.md itself is the provider (installs and authenticates gh before gh repo clone).
  • shared_step_before_environment_setup for 01-SQ02 is the same problem as above (one fix).

This issue is ready for an agent to resolve.

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

  • expires on Nov 23, 2026, 8:02 AM UTC
Vorherrschende Sprache
JavaScript
Sterne
61
Forks
43
Ø Merge
10 Std. 38 Min.
Gemergte PRs (30 T.)
12

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.