feat(docs-site): Lore documentation site on GitHub Pages [roadmap:v0.10.7] - #78
Merged
Conversation
Adds rac/designs/docs-site-scoping.md (RAC-KTYW08RYZ4WV): Phase 1 scoping for the MkDocs Material documentation site on GitHub Pages. Covers: - site map for all nine docs/ pages plus a new landing page - landing page wireframe (hero, install, value proposition, doc links) - file-level change list and README diff plan per ADR-022 - drift-prevention policy between README and site - open questions and deferred items (blog, versioning, analytics, custom domain, i18n) Notes the ADR-022 review trigger for external documentation hosting and hands off requirement grouping and the v0.10.7 roadmap slot to Phase 2.
Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Adds the v0.10.7 roadmap item for the Lore documentation site: four initiatives (site platform, landing page, publish pipeline, README doorway), constraints, non-goals, and the implementation contract drawn from the approved docs-site-scoping design. Updates the CLAUDE.md working-corpus pointer from the stale v0.10.4 to v0.10.7.
…v0.10.7] Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Adds: - rac/requirements/rac-docs-site-platform.md — MkDocs Material site, nav, search, sourced from docs/ unrewritten - rac/requirements/rac-docs-site-landing-page.md — hero, install, value proposition, above-the-fold contract at 1280x800 - rac/requirements/rac-docs-site-publish-pipeline.md — Actions to Pages with mkdocs build --strict as the gate - rac/requirements/rac-docs-site-readme-doorway.md — README reduced to the ADR-022 doorway with the drift policy - rac/decisions/adr-042-docs-site-hosting.md — hosting model and drift policy, answering ADR-022's external-hosting review trigger All artifacts pass rac validate, rac relationships --validate, and rac review with no priority 1-2 findings.
…0.10.7]
Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md.
Adds:
- mkdocs.yml: Material theme, light/dark palettes, built-in search,
explicit nav per the approved site map, pinned site_url and repo_url
- docs/index.md: landing page per the docs-site-scoping wireframe; hero
art, tagline, install, doc links above the fold, relocated README
depth below
- docs/images/lore-header-{light,dark}.png: hero art copies so the
build is self-contained under docs/
- seven link-target conversions (ecosystem 3, mcp 1, repo-workflow 1,
testing 2) from ../ paths to absolute GitHub URLs so the strict
build passes; no prose changed
- .gitignore: exclude MkDocs site/ output, which is never committed
Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Builds with mkdocs build --strict on every push to main, so broken links or nav fail the workflow before deploy, and publishes via the official configure-pages/upload-pages-artifact/deploy-pages actions with least-privilege permissions. No gh-pages branch; first deploy requires the maintainer to set Pages source to GitHub Actions.
Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Keeps the doorway contents ADR-022 requires (hero, badges, tagline, condensed summary, install, agent-connection example, common commands, who it's for, documentation links, status, license) and moves the depth content — why this works, the SDD comparison table, the trust section, the long-form grounding walkthrough — to the site landing page per the ADR-042 drift policy. Documentation links now point at the site instead of GitHub blob URLs. 163 lines down to 71.
Resolves README.md by keeping the ADR-022 doorway shape: the new 'Sharing the corpus (the Portal)' section relocates to the site landing page per the ADR-042 drift policy, and the doorway's common-commands block gains the rac export line. Resolves CLAUDE.md to main's v0.11.x-portal series pointer, noting the in-flight v0.10.7 docs-site item.
…oadmap:v0.10.7] Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. main's v0.11.0 release added a 'Sharing the corpus (the Portal)' section to the README after these requirements were authored. Amends the contracts to absorb it under the existing drift policy: - rac-docs-site-landing-page REQ-007: the Portal section joins the below-fold order between the trust section and the footer - rac-docs-site-readme-doorway REQ-001/REQ-003: the doorway command block gains rac export; the full Portal section relocates to the landing page - rac-docs-site-readme-doorway REQ-005: the condensed product summary joins the drift-policy exception list, closing the gap flagged in the implementation PR
….10.7] Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Replaces the stock Material landing with an OpenSpec-style splash rendered in the lore-web visual identity: - overrides/home.html: custom home template with a two-column hero — lamplighter mascot left, tagline headline + 'Agents that know why.' subhead + copyable install card + Quickstart/MCP/CLI/GitHub CTA row right. Below-the-fold sections still render from docs/index.md. - docs/stylesheets/extra.css: maps Material's slate scheme onto the lore-web tokens (warm near-black surfaces, amber accent, teal commands), dashed terminal chrome, JetBrains Mono. - docs/fonts/: JetBrains Mono 400/700 self-hosted (with OFL license); theme.font is false so the site makes no external font requests. - docs/images/lamplighter.png, favicon.png: vendored brand assets. - mkdocs.yml: custom_dir, single dark scheme, content.code.copy. Single dark scheme (the identity defines no light palette), so the former light/dark lore-header art is removed.
…map:v0.10.7] Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Brings the governing artifacts in line with the maintainer's decision to render the landing in the lore-web identity (OpenSpec-style hero, amber-on-warm-black, JetBrains Mono, lamplighter mascot, single dark scheme): - docs-site-scoping: flips the rejected custom-landing alternative to the chosen approach; relaxes the stock-Material constraint to a bounded custom template + stylesheet + self-hosted fonts; records the dark-only scheme and the GATE-1 publish-sequencing rule; updates Style Guidance to the lore-web tokens and Accessibility to the WCAG-AA-checked palette. - rac-docs-site-landing-page REQ-002/008/009: mascot instead of light/dark header art; bounded custom code; OpenSpec hero structure. - rac-docs-site-platform REQ-001/009: custom_dir, stylesheet, and self-hosted fonts permitted; single dark scheme, no external requests. - rac-docs-site-publish-pipeline REQ-007: enabling Pages waits for the lore-web GATE-1 comms review, since the landing now carries the pre-launch brand. - adr-042: records the GATE-1 coupling as a consequence.
…p:v0.10.7] Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Splits the hero into a lead row (mascot top-aligned with the headline and subhead) and a full-width actions band beneath, so the install card stretches under both columns with the CTA row below it.
Implements rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md. Sets the splash to the same 46rem column as the below-the-fold sections and drops its horizontal padding, so the hero and content share identical left/right edges. Also corrects the below-fold section-divider, blockquote, and table rules, which targeted a nested .md-typeset that does not exist and were silently no-ops.
tcballard
added a commit
that referenced
this pull request
Jun 13, 2026
ADR-042 was taken by docs-site hosting (#78, merged to main). Renames the watchkeeper revision-materialization decision to ADR-043 and updates its references in the v0.12.0/v0.12.3 roadmaps and the watchkeeper docs, so 'ADR-043' resolves to this decision and 'ADR-042' stays the docs-site decision. Implements rac/roadmaps/v0.12.x-watchkeeper/v0.12.0-repository-review.md.
This was referenced Jun 13, 2026
tcballard
added a commit
that referenced
this pull request
Jun 13, 2026
ADR-042 was taken by docs-site hosting (#78, merged to main). Renames the watchkeeper revision-materialization decision to ADR-043 and updates its references in the v0.12.0/v0.12.3 roadmaps and the watchkeeper docs, so 'ADR-043' resolves to this decision and 'ADR-042' stays the docs-site decision. Implements rac/roadmaps/v0.12.x-watchkeeper/v0.12.0-repository-review.md.
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
Implements
rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md.Adds:
docs/pages with sidebar nav and search, plus a new landing page at the site rootmkdocs build --stricton every push tomainand deploys to GitHub Pages via the official Pages actionsPost-v0.11.0 reconciliation: main merged the portal-export release (#77) while this PR was open. This branch has merged
origin/main; the README's new "Sharing the corpus (the Portal)" section relocates to the landing page under the same drift policy, the doorway's command block gainsrac export, and the two affected requirement artifacts are amended to record exactly that (commit148cda4). The lore-web surface is untouched, and its GATE-1 (nothing public before comms review) is respected: this site publishes only after the maintainer manually enables Pages.Roadmap / ADR Trace
Roadmap:
rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.mdRelevant ADRs:
rac/decisions/adr-042-docs-site-hosting.md(new — hosting model + drift policy, answering ADR-022's external-hosting review trigger)rac/decisions/adr-022-documentation-boundaries.md(unchanged; its three layers stand)rac/decisions/adr-036-lore-product-identity.md(Lore leads on the landing page; docs keep the RAC voice)Requirements (the specification for this PR):
rac/requirements/rac-docs-site-platform.mdrac/requirements/rac-docs-site-landing-page.mdrac/requirements/rac-docs-site-publish-pipeline.mdrac/requirements/rac-docs-site-readme-doorway.mdScope
Included
mkdocs.yml: Material theme, light/dark palettes, built-in search only, explicit nav in the approved site-map order, pinnedsite_url/repo_urldocs/index.md: landing page — hero art (light/dark via Material's stock#only-light/#only-dark), tagline as H1, install, three doc links, then the README's relocated depth sections (including the v0.11.0 Portal section)docs/images/lore-header-{light,dark}.png: copies of the brand art so the build is self-contained underdocs/.github/workflows/docs.yml: build + deploy, strict mode as the gate, least-privilege permissionsREADME.md: doorway only; documentation links now point at the site; command block includesrac export.gitignore:site/excluded (declared addition to the approved file list — it protects the "generated HTML is never committed" requirement)Excluded
docs-site-scoping; no artifacts, no coderac/corpus content on the site (ADR-022 boundary)lore-web/and the portal-export code: untouched by this branch beyond the merge from mainProduct / Architecture Decisions
mkdocs==1.6.1,mkdocs-material==9.7.6) rather than a new requirements file, keeping to the approved file-level change list#only-light/#only-darkimage fragments — zero override files shippedUser-Facing Contract
/quickstart/,/mcp/,/cli/,/artifacts/,/relationships/,/repo-workflow/,/examples/,/ecosystem/,/testing/— the nine pages, served unrewrittenhttps://tcballard.github.io/requirements-as-code/mainbuild the site; any MkDocs warning (broken link/nav) fails the workflow and blocks deployVerification
Ran (re-run in full after merging origin/main)
Rendered verification used headless Chromium at a 1280×800 viewport against the built site.
Acceptance criteria — pass/fail
rac-docs-site-platform — 6/6 pass
mkdocs build --strictexits 0, no warningsdocs/(site output audited)mkdocs==1.6.1,mkdocs-material==9.7.6)rac-docs-site-landing-page — 6/6 pass
docs/index.mdas Homerac-docs-site-publish-pipeline — 6/6 pass
docs.ymlexists, parses, triggers onpushtomainonlyconfigure-pages@v5/upload-pages-artifact@v3/deploy-pages@v4, no third-party actionsgh-pagesbranch;site/gitignored, no generated HTML committedpermissionsblock is exactlycontents: read,pages: write,id-token: writerac-docs-site-readme-doorway — 5/5 pass
rac export); no REQ-003 section heading appearsgrepfinds zeroblob/main/docs/linksdocs/index.mdonly148cda4)Artifact amendments made mid-implementation (all in commit
148cda4)main's v0.11.0 release changed the README after the requirements were approved; the contracts were amended — not silently bypassed — to absorb it:
rac-docs-site-landing-pageREQ-007: Portal section added to the below-fold orderrac-docs-site-readme-doorwayREQ-001: command block is now four commands (rac exportadded)rac-docs-site-readme-doorwayREQ-003: Portal section added to the relocated-sections listrac-docs-site-readme-doorwayREQ-005: condensed product summary added to the drift-policy exceptions (closes the gap flagged in the original PR text)Content edits to existing docs/ pages (complete list)
Link targets only — no prose changed:
docs/ecosystem.md:../rac/→ absolute GitHub URLdocs/ecosystem.md:../.claude/skills/rac-artifacts/SKILL.md→ absolute GitHub URLdocs/ecosystem.md:../examples/guide/demo.md→ absolute GitHub URLdocs/mcp.md:../examples/guide/→ absolute GitHub URLdocs/repo-workflow.md:../rac/decisions/adr-022-…→ absolute GitHub URLdocs/testing.md:../rac/decisions/adr-023-…→ absolute GitHub URLdocs/testing.md:../rac/prompts/rac-agent-commit-guidelines.md→ absolute GitHub URLLanding-page formatting adjustments to relocated copy (not prose rewrites): the naming paragraph's trailing colon became a period (it no longer leads into a code block), and the walkthrough example is introduced by "Point your agent at your repo and ask:" condensed from the README's step framing.
Review Path
rac/designs/docs-site-scoping.md— the approved scope everything traces torac/requirements/rac-docs-site-*.md,rac/decisions/adr-042-docs-site-hosting.md,rac/roadmaps/v0.10.x-guide/v0.10.7-docs-site.md— the specification (note the amendments commit148cda4)mkdocs.yml,docs/index.md— the site.github/workflows/docs.yml— the pipelineREADME.md— the doorway diff and merge resolutionNotes For Reviewer — manual steps required
mainreceives a push.v0.10.7in the now-previous series, approved before v0.11.0 started the portal series. If you'd rather it bev0.11.1, it's a one-commit rename — say the word.pyproject.toml'sHomepageURL should point at the site once live.Implementation Process
Implemented with AI assistance under the roadmap contract.
Final scope, review, and acceptance decisions were made by the maintainer.