Skip to content
prod e051e98
Browse

Playbook phase hub template

  • Shelf: build/playbooks/<collection>/<workstream>/0N-phase/index.mdx
  • kind: playbook (phase hub — not a numbered step; no stepNumber)
  • 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): overviewphase hubstep.

  • 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.
SectionJobWhy it’s here
Intro + :::tip[Why…]Phase motivationTutorial chapter framing
What X actually isConcept + bullet listExplanation before procedure
<FileTree> / diagramStructure or flowWarrant test for relationship/process
Phase <Stepper>Step previews in phaseProgress within phase
Kit shortcut calloutOptional install pathLinks kit without replacing verify step
Sub-steps listPlain 1. linksAgent + print friendly
Committed vs gitignored tableOne-time policyReduces repeated step prose

Use .mdx when using Stepper, FileTree, or diagrams.

---
title: "Phase N · &lt;Phase name&gt;"
description: One sentence — what this phase delivers and why later phases depend on it.
sidebar:
label: Phase N overview
order: 0
phase: "N"
category: <category>
subcategory: <workstream>
collectionOrder: N
kind: playbook
estTime: ~N min
status: current
tags: [playbook, topic]
prereqs:
- &lt;phase or env prereq&gt;
---
import Stepper from '~/components/Stepper.astro';
import { FileTree } from '@astrojs/starlight/components';
&lt;Intro — what this phase does in the larger playbook.&gt;
:::tip[Why this is Phase N, not an afterthought]
&lt;2–4 sentences — risk, dependency, or speed rationale.&gt;
:::
## What "&lt;phase subject&gt;" actually is
&lt;Bullet list of artifacts / outcomes.&gt;
&lt;Optional FileTree or ```mermaid``` when structure or boot flow warrants it.&gt;
## The flow at a glance
<Stepper
id="&lt;workstream-phase-N&gt;"
steps={[
{ title: '&lt;Step title&gt;', body: 'One-line preview. See <a href="">Step slug</a>.' },
]}
/>
## Skip the typing — use the kit
&lt;Only when a kit exists for this phase.&gt;
:::note[Kit shortcut — steps X–Y]
Download the **[&lt;Kit name&gt;](/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. [&lt;Step&gt;](/tech-stack/laravel/codecanyon/build/playbooks/setup-new/01-ai-system/01-project-setup/) — one-line
2. …
## &lt;Optional policy section — e.g. committed vs gitignored&gt;
| File | Committed? | Why |
| --- | --- | --- |
| … | … | … |
  • Do not add stepNumber frontmatter on the phase hub.
  • Do not use :::next on 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.