Skip to content

docs(site): build a first-class learning product - #554

Merged
SUaDtL merged 22 commits into
mainfrom
codex/docs-first-class-site
Jul 30, 2026
Merged

docs(site): build a first-class learning product#554
SUaDtL merged 22 commits into
mainfrom
codex/docs-first-class-site

Conversation

@SUaDtL

@SUaDtL SUaDtL commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • turns the documentation site into a complete novice-to-power-user learning product, with task-led onboarding, operating guidance, concepts, references, and advanced labs
  • restores the historic gate/terminal identity as a polished, exact SVG system and carries it into a deterministic README hero
  • adds a persistent documentation rail and accessible drawer with a responsive content gutter, contained focus, inert background, keyboard handling, and Astro-navigation lifecycle safety
  • keeps the atmospheric landing art fixed while content scrolls, removes the splash seam, and replaces fictional product behavior with a real 16-second hook replay and explicit provenance
  • rebuilds the diagram family as 15 aligned, accessible, audited SVGs with self-contained font fallbacks
  • audits every authored and generated page for actionable use, improves the generators and source links, and synchronizes the root README with the finished learning experience
  • merges current main into the worktree branch and removes unrelated release/version drift from this documentation-only change

This PR intentionally remains draft/WIP. It must not be merged accidentally.

Evidence

  • page-by-page documentation audit: docs/reports/docs-site/page-audit.md
  • representative live browser QA at 1440px desktop, 1024px tablet, and 390px mobile
  • verified drawer keyboard/focus behavior, background inertness, close/restore behavior, and landing → docs → browser Back → drawer reopen lifecycle
  • directly rendered generated SVGs to prove their external-image typography and alignment
  • landing replay is sourced from the repository's real hook/runtime behavior rather than an invented interaction

Verification on da167389f11f12a9ac200ae5b2f17ecfbb7df339

  • npm test — 47 files, 492 tests passed
  • npm run typecheck — passed
  • npm run coverage — passed
    • statements: 71.24% (793/1113)
    • branches: 70.14% (423/603)
    • functions: 75.97% (136/179)
    • lines: 70.72% (715/1011)
  • npm run build — passed; 134 pages built and Pagefind indexed 140 HTML files
  • npm run link-audit — 20,057 internal links across 140 pages resolve; favicon and hashed logo present
  • npm run audit:diagrams — passed
  • python tools/sync-core.py --check — 53 core files across 3 plugins are byte-identical
  • python tools/build-surface.py --check — Claude, Codex, and Pi generated surfaces are in sync
  • npm run gen:readme-hero plus diff check — deterministic and clean
  • git diff --check — passed

Design decision

SMARTS selected a hybrid visual system: rendered atmosphere for distinction, editable SVG for diagrams and the exact brand mark, and real captured product behavior for training evidence. This keeps the site memorable without making operational claims it cannot prove.

SUaDtL added 7 commits July 30, 2026 09:49
Keep the public release route, governing skill, version surfaces, and changelog-footer policy consistent across all four plugin targets.

CHANGELOG: Correct the release command and skill contracts for target selection and required changelog footers.
Turn the documentation into a source-aware curriculum and product-quality reference so a new operator can progress from installation to governed power-user workflows with verifiable evidence.

Replace simulated splash content with a rendered replay of a direct shipped-hook invocation, add a custom visual system, and make host availability and generated references derive from shipped source.
Move the target-aware release documentation into core/surface and regenerate Claude, Codex, and Pi host files so hosted parity checks cannot overwrite or reject the reviewed contract.

Restore the required Feature Forge preview disclosure on the product splash.

CHANGELOG: Keep the target-aware release command synchronized across every generated governance host.
Remove the lone prose-separator dash from the learning capstone so the site voice check passes on the hosted Linux generator job.
Allow source renderers to accept an explicit source ref in tests while preserving the production default from GITHUB_SHA. This keeps exact-revision links and makes detached CI runs deterministic.
Advance ca-codex to 0.3.5 and ca-pi to 0.1.41, regenerate Pi root package metadata, and record the canonical release-surface synchronization in both host changelogs.
Reframe the documentation as a novice-to-power-user product, upgrade the shared visual system and generated references, and align the README with the same source-backed learning path.

CHANGELOG: Rebuilds the documentation and README into a branded, source-backed learning path from first install to power-user operation.
@SUaDtL SUaDtL changed the title docs(site): build first-class learning experience docs(site): build a first-class learning product Jul 30, 2026
@SUaDtL
SUaDtL marked this pull request as ready for review July 30, 2026 21:32
@SUaDtL
SUaDtL merged commit e2e1e79 into main Jul 30, 2026
42 checks passed
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