Playbook phase hub template
When to use
Section titled “When to use”- Shelf:
build/playbooks/<collection>/<workstream>/0N-phase/index.mdx kind:playbook(phase hub — not a numbered step; nostepNumber)- Diátaxis mode: tutorial (phase-level unit within a larger journey)
- Readers served: readers entering one phase; agents routing to the correct step; kit users who need shortcut callouts (steps N–M)
Part of the Playbook set (3 templates): overview → phase hub → step.
Design rationale
Section titled “Design rationale”- Phases are tutorial chapters — within a Diátaxis tutorial, each chapter has its own orientation before exercises (steps); the phase hub is that chapter front matter (Diátaxis tutorials).
- “Why this phase first” callout — motivation block (
:::tip) answers perfectionist “why can’t I skip?” without bloating every step (learning objective upfront). - Relationship diagram when the phase installs a system — e.g. AI System boot flow warrants Mermaid or SVG; prose-only for multi-component phases fails the warrant test (ZajLibrary visuals gate).
<FileTree>for target repo shape — when the phase materializes files, show the end-state tree once on the hub; steps link back instead of repeating (Google — file structure in procedures).- Kit shortcut as honest partial path — Good Docs install pattern applies to kits that shortcut steps 3–6, not the whole phase; callout must name remaining steps (Good Docs installation guide).
- Numbered sub-step list at bottom — redundant with Stepper but gives a printable, agent-parseable manifest without JavaScript.
| Section | Job | Why it’s here |
|---|---|---|
Intro + :::tip[Why…] | Phase motivation | Tutorial chapter framing |
| What X actually is | Concept + bullet list | Explanation before procedure |
<FileTree> / diagram | Structure or flow | Warrant test for relationship/process |
Phase <Stepper> | Step previews in phase | Progress within phase |
| Kit shortcut callout | Optional install path | Links kit without replacing verify step |
| Sub-steps list | Plain 1. links | Agent + print friendly |
| Committed vs gitignored table | One-time policy | Reduces repeated step prose |
Copy-paste skeleton
Section titled “Copy-paste skeleton”Use .mdx when using Stepper, FileTree, or diagrams.
---title: "Phase N · <Phase name>"description: One sentence — what this phase delivers and why later phases depend on it.sidebar: label: Phase N overview order: 0phase: "N"category: <category>subcategory: <workstream>collectionOrder: Nkind: playbookestTime: ~N minstatus: currenttags: [playbook, topic]prereqs: - <phase or env prereq>---
import Stepper from '~/components/Stepper.astro';import { FileTree } from '@astrojs/starlight/components';
<Intro — what this phase does in the larger playbook.>
:::tip[Why this is Phase N, not an afterthought]<2–4 sentences — risk, dependency, or speed rationale.>:::
## What "<phase subject>" actually is
<Bullet list of artifacts / outcomes.>
<Optional FileTree or ```mermaid``` when structure or boot flow warrants it.>
## The flow at a glance
<Stepper id="<workstream-phase-N>" steps={[ { title: '<Step title>', body: 'One-line preview. See <a href="…">Step slug</a>.' }, … ]}/>
## Skip the typing — use the kit
<Only when a kit exists for this phase.>
:::note[Kit shortcut — steps X–Y]Download the **[<Kit name>](/tech-stack/laravel/codecanyon/resources/kits/ai-system/)**, copy to project root, run **`seed.sh`** as an alternative through steps X–Y (after steps 1–2). Details in **[Step title](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/01-ai-system/03-project-constitution/#alternative--kit--seedsh)**. Still finish **[Verify step](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/01-ai-system/07-verify-and-gate/)**.:::
➡️ **[Kit link](/tech-stack/laravel/codecanyon/resources/kits/ai-system/)** — one-line install summary.
## Sub-steps
1. [<Step>](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/01-ai-system/01-project-setup/) — one-line2. …
## <Optional policy section — e.g. committed vs gitignored>
| File | Committed? | Why || --- | --- | --- || … | … | … |Anti-patterns
Section titled “Anti-patterns”- Do not add
stepNumberfrontmatter on the phase hub. - Do not use
:::nexton the hub — reserve for step pages. - Do not imply a kit replaces verify/gate steps without explicit links to them.
- Do not skip the diagram when the phase explains a multi-component boot or ownership model.
Worked example
Section titled “Worked example”Sources
Section titled “Sources”- Diátaxis — Tutorials — phased learning units within a larger tutorial journey.
- Good Docs Project — Installation guide template — kit shortcut pattern (partial install path + verify elsewhere).
- NN/g — How users read on the web — scannable sub-step lists and upfront motivation blocks.
- Google developer documentation style guide — Procedures — phase-level orientation before numbered step procedures.
- Writing style → Doc-type spines — Playbook set (overview · phase hub · step) and kit vs playbook boundaries.