Skip to content

docs site: materialize the 20 [TODO]-stub pages#342

Merged
clkao merged 2 commits into
mainfrom
spacedock-ensign/docs-site-materialize-todos
Jun 10, 2026
Merged

docs site: materialize the 20 [TODO]-stub pages#342
clkao merged 2 commits into
mainfrom
spacedock-ensign/docs-site-materialize-todos

Conversation

@gcko

@gcko gcko commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Fills every [TODO]-stub page in the MkDocs site with real content, grounded in the repository and conformed to the Voice & tone guide.

Per the thread on #315, this branches off PR #341 (spacedock-ensign/mkdocs-material-docs-site) and targets it as the base, rather than committing to #341 directly — so #341 can merge after the flip with the docs already materialized on its branch.

What changed

20 stub pages went from a one-line [TODO] placeholder to full content:

  • Get started — Home, first launch, first workflow.
  • Concepts — operating model, workflows & entities, stage lifecycle, gates & decisions, and a worked example tracing the real z9 codex-plugin-auto-install entity (PR Codex plugin auto-install on spacedock codex (mirror #311; codex 0.137.0 marketplace + plugin add) #329) through every stage.
  • Running workflows — commission, survey, operating, debrief & refit.
  • Advanced — sprints & roadmap, mods & standing teammates, split-root state.
  • Reference — command reference, frontmatter contract.
  • Contributing — proof policy, adding a runtime, architecture notes.

How it was written

Each page was written grounded in real repo source (the README, the dev-workflow reference, the skills/*/SKILL.md definitions, the cmd/ and internal/ command surface, docs/specs/, and the docs/roadmap/ sprint records), then independently reviewed against the voice guide and spot-checked for factual accuracy against the repo.

Verification

🤖 Generated with Claude Code

@gcko

gcko commented Jun 9, 2026

Copy link
Copy Markdown
Contributor Author

The documentation is clear and easy to read. It is human-first and does not use an overabundance of AI-generated semantics (emdash, semicolon run-on sentences, etc)

Screenshot 2026-06-09 at 15 21 07 Screenshot 2026-06-09 at 15 21 08 Screenshot 2026-06-09 at 15 21 19

@clkao clkao changed the base branch from spacedock-ensign/mkdocs-material-docs-site to main June 10, 2026 19:05
gcko and others added 2 commits June 10, 2026 12:10
Fill every stub page in the MkDocs site with real content, grounded in
the repository (README, the dev-workflow reference, the skills, the cmd/
and internal/ command surface, docs/specs, and the docs/roadmap sprint
records) and conformed to docs/site/contributing/voice-and-tone.md.

- Get started: Home, first launch, first workflow.
- Concepts: operating model, workflows & entities, stage lifecycle,
  gates & decisions, and a worked example tracing the real z9
  codex-plugin-auto-install entity (PR #329) through every stage.
- Running workflows: commission, survey, operating, debrief & refit.
- Advanced: sprints & roadmap, mods & standing teammates, split-root state.
- Reference: command reference, frontmatter contract.
- Contributing: proof policy, adding a runtime, architecture notes.

No [TODO] markers remain; `mkdocs build --strict` passes (all internal
links and nav entries resolve).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copy-edit pass over the 20 materialized pages to remove prose em-dashes,
a common tell of AI-generated text. Each instance was reworked for the
sentence rather than swapped uniformly: periods where the dash joined an
independent clause, colons for definitions and lists, parentheses for
true asides, light commas, and outright restructures where no substitute
read naturally.

Em-dashes inside code spans and fenced blocks (the gate-review template,
a bash comment, the inline workflow-not-found error string) are literal
content and left intact. No technical facts, commands, flags, paths,
links, role names, or stage names changed; `mkdocs build --strict` passes.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@clkao clkao force-pushed the spacedock-ensign/docs-site-materialize-todos branch from b030489 to 0db381a Compare June 10, 2026 19:11
@clkao clkao merged commit 3f941ba into main Jun 10, 2026
2 checks passed
@clkao clkao deleted the spacedock-ensign/docs-site-materialize-todos branch June 10, 2026 19:21
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.

2 participants