docs site: address Karen's feedback — simplify, dedupe, fix rendering#343
Open
gcko wants to merge 1 commit into
Open
docs site: address Karen's feedback — simplify, dedupe, fix rendering#343gcko wants to merge 1 commit into
gcko wants to merge 1 commit into
Conversation
Apply the Recce doc-writing principle as a standing directive and act on the review of Karen's feedback: - Add docs/site/CLAUDE.md authoring directive (simplicity + concept/tutorial/ reference structure), excluded from the published build; defers to voice-and-tone.md for voice. - Home: lead with the problem before the "multi-agent orchestrator" claim; cut the up-front term dump from 7 to 2. - Fix the install-page ordered-list numbering bug (3- to 4-space indent) and collapse the three install paths into tabs. - Fix dark-on-dark header in slate mode (brand.css header foreground). - Reframe stage-lifecycle so stages read as workflow-defined, not canonical. - worked-example: show real artifact excerpts instead of only narrating them. - Dedupe: operating -> gates-and-decisions; first-launch -> survey; first-workflow -> commission (and correct the design-pass to 4 things). - Move command grammar off install; move build-from-source to Contributing; merge multi-host into contributing/adding-a-runtime; remove sprints-and-roadmap. - frontmatter-contract: move rationale prose into concept pages, keep tables. - mkdocs: canonical site_url https://spacedock.md/docs/. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses Karen's feedback on the Spacedock docs. Her two headline asks — the docs are wordy / Spacedock feels complex, and apply the Recce doc-writing principle — drove the whole pass.
It does two things:
docs/site/CLAUDE.mdauthoring directive (adapted from Recce'sdoc.md) governs structure + simplicity for everything underdocs/site/; it's auto-loaded when editing docs and defers tovoice-and-tone.mdfor voice. Excluded from the published build viaexclude_docs.Visual verification
The three issues Karen could see, before → after (slate theme, the live default):
"The layout is gone" (Home) + too many terms up front
The header rendered dark-on-dark in slate mode (Material colored header text with a dark ink while brand.css forced a dark header background). One line in
brand.cssrestores it. The Home copy now leads with the problem before the "multi-agent orchestrator" claim and introduces 2 terms instead of 7.Install: numbered steps all rendered as "1", three repetitive sections
The steps restarted at "1" (3-space list indent — Python-Markdown needs 4). The three install paths are now tabs (
pymdownx.tabbed), with shared Confirm / Launch steps appearing once.(Before = the currently-deployed
spacedock.md/docs; after = this branch built locally. The header fix only becomes visible on the live site once it redeploys from this branch.)Changes
Applied directly (writing / structure / rendering):
brand.css).workflow,commission,first officer,stage chain,approval gates).gatedefinition.z9artifact excerpts instead of only narrating them.gates-and-decisions.Gated decisions (resolved with the maintainer):
spacedock.md(the landing page exists); "layout gone" was the CSS bug above.Build from sourcemoved to a new Contributing page; install keeps a pointer.reference/multi-hostinto Contributing →adding-a-runtime(it's a contributor build guide).Also:
site_urlset to the canonicalhttps://spacedock.md/docs/.How analysis was done
A multi-agent workflow read every page Karen linked against the doc-writing principle, classified each item as direct-vs-gated, and verified the rendering bugs (list-numbering reproduced through the exact Python-Markdown config;
z9artifacts confirmed real indocs/roadmap/0198-pre-flip-hardening/).Verification
mkdocs build --strictpasses (deps pinned indocs/requirements.txt).🤖 Generated with Claude Code