Skip to content

docs(tutorial): outcome hero, core/rest syntax split, one "how to run" home - #6

Merged
tickets-forge-dev merged 3 commits into
masterfrom
docs/tutorial-overhaul
Jun 29, 2026
Merged

tickets-forge-dev merged 3 commits into
masterfrom
docs/tutorial-overhaul

Conversation

@tickets-forge-dev

Copy link
Copy Markdown
Owner

Reorganizes the tutorial and keyword reference around three asks.

1 · Hero — show the power, not a comparison

Replaces the good-vs-bad hero (messy Claude session vs a clean .loop) with a single outcome-in-motion terminal — the loop self-correcting ✗ fail → reflect → edit → ✓ green → ⛐ gate → PR #128, never main — and the one .loop that drove it just below. New framing: "Stop babysitting the agent."

2 · Split the syntax into core + the rest

  • TOC regrouped into Core syntax · the five decisions and The rest of the syntax.
  • #what now names the split (these five are the engine; everything else composes or configures).
  • New #beyond section catalogs the non-core constructs — Compose / Augment / Ops & reuse — each linking to its keyword page.
  • Keyword reference recut into two tiers with re-sorted groups; the 22 detail-page category badges synced to the new taxonomy (Core syntax / Compose / Augment / Human-in-the-loop / Ops & reuse). Added the missing use skills + remember in pages + cards (shipped in 0.4.0, never documented here).

3 · One "how to run" home

  • "Running a loop" opens with a 3-way chooser: ① write by hand in VS Code · ② run in Claude Code (recommended) · ③ run headless via the CLI.
  • VS Code was documented twice, inconsistently (getting-started + running) — consolidated into a single #running-vscode subsection; getting-started trimmed to a pointer; loop.runMode standardized on ask/session/output.

Verification

  • All in-page anchors resolve; <section>/<table>/<ul> balanced; vscode-optional gone, runMode mentioned once.
  • Every keyword card + tutorial→keyword link resolves to a file (25 cards = 23 + 2 new).
  • Rendered locally (Playwright): hero, the running chooser, and the two keyword tiers all display correctly.

Docs-only; no packages/ changes (the VS Code 0.4.0 work is PR #5).

🤖 Generated with Claude Code

tickets-forge-dev and others added 3 commits June 29, 2026 09:20
…" home

Tutorial (docs/index.html):
- Hero: replace the good-vs-bad comparison with a single outcome-in-motion
  terminal — the loop self-correcting fail → reflect → green → gated PR — with
  the .loop that drove it below. New "Stop babysitting the agent" framing.
- Syntax split: TOC regrouped into "Core syntax · the five decisions" and
  "The rest of the syntax"; #what names the core/rest cut; new #beyond section
  catalogs the non-core constructs (compose / augment / ops) with reference links.
- One "how to run" home: a 3-way chooser (write by hand in VS Code · run in
  Claude Code [recommended] · run headless via the CLI), VS Code consolidated
  into a single #running-vscode subsection (was documented twice, inconsistently),
  getting-started trimmed to a pointer. runMode standardized on ask/session/output.

Keyword reference (docs/keywords/):
- Recut into two tiers (Core syntax / The rest) with re-sorted groups; detail-page
  category badges synced (Core syntax / Compose / Augment / Human / Ops & reuse).
- Add the missing use-skills + remember-in pages and cards (0.4.0 constructs).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- Replace the animated terminal with a static, auto-height full run trace so
  there's no oversized empty box (the fixed 330px pane left dead space). Drop
  the now-unused animation script.
- Remove the Workshop / LoopFlow Lab links from the hero lede so it doesn't
  push readers out of the tutorial before they start (still linked from
  Getting started and the TOC).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@tickets-forge-dev
tickets-forge-dev merged commit 9971004 into master Jun 29, 2026
2 checks passed
@tickets-forge-dev
tickets-forge-dev deleted the docs/tutorial-overhaul branch June 29, 2026 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant