Skip to content

docs: sync README/ROADMAP/ARCHITECTURE with what's actually shipped#37

Merged
CodeWithJuber merged 1 commit into
masterfrom
claude/whitepaper-implementation-plan-x8f7bh
Jul 8, 2026
Merged

docs: sync README/ROADMAP/ARCHITECTURE with what's actually shipped#37
CodeWithJuber merged 1 commit into
masterfrom
claude/whitepaper-implementation-plan-x8f7bh

Conversation

@CodeWithJuber

Copy link
Copy Markdown
Owner

What & why

The user flagged that "all documents, md files and other things are not updated with our implementation." Grepping README.md, ROADMAP.md, and ARCHITECTURE.md against the real repo state on master confirmed specific, concrete staleness:

  • README.md ## GitLab Pages landing page described only the old setup (public/index.html status page via .gitlab-ci.yml) — it said nothing about the new landing/index.html professional redesign (PR Professional redesign of the landing + status pages, gated by forge's own UI system #36), the shared design system gated by forge uicheck design/forge uicheck visual, or the live GitHub Pages deployment (.github/workflows/static.yml) that serves the landing page at the site root and the status page at /status/. The section title itself was wrong — public/index.html is titled "forgekit status", not a landing page.
  • ROADMAP.md had a stale v0.5.0 version header (actual: 0.6.0) and listed the embeddings tier and Playwright loop as open ## Next work when both are already fully shipped (per CHANGELOG.md's [Unreleased] section, merged in PR Roadmap "Next" wave: ledger read-path flip, optional embeddings tier, Playwright visual gate #35). The public-site redesign wasn't mentioned anywhere.
  • ARCHITECTURE.md's repo-layout component map was missing three shipped modules (embed.js, ledger_read.js, taste.js) and didn't mention the public-site build system at all.

This PR is a docs-only sync — no source changes. Verified as already accurate and left untouched: CHANGELOG.md (already documents everything correctly; cutting a version is the owner-run bump.yml Action, out of scope here), docs/GUIDE.md, ONBOARDING.md.

Checklist

  • npm test passes (Node 18/20/22) — no source changes, existing suite unaffected
  • npm run check passes (Biome lint + format) — markdown-only, not covered by Biome
  • New public functions have a test — n/a, no code changes
  • Conventional commit message (feat:/fix:/docs: …)
  • CHANGELOG.md updated under ## [Unreleased] — n/a, this PR is a docs-accuracy fix, not a feature; nothing shipped that needs a changelog entry
  • No new runtime dependency (dev deps ok)
  • Substrate/docs updated if this changes forge substrate, forge impact, router/gate, or MCP substrate tools — n/a, but docs updated regardless

Risk & rollback

  • Risk level: low (docs-only, three .md files)
  • Rollback plan: revert the commit; no code or runtime behavior is affected

Extra checks (tick if applicable)

  • npm run typecheck passes — n/a, no .js/.ts changes
  • Input validated at boundaries; errors handled (no swallowing) — n/a
  • Authorization/ownership checked (if it touches access) — n/a
  • Logs contain no secrets/PII — n/a
  • If AI-assisted: I understand it, verified the package APIs, and it has tests — n/a (docs), but every added claim (module names/line refs, workflow behavior, shipped-feature status) was verified against the actual files on master before writing, not assumed

Generated by Claude Code

- README.md: replace the stale "GitLab Pages landing page" section with an
  accurate "Public site" section describing both landing/index.html (the
  new professional landing page) and public/index.html (the generated
  status page), the shared design system gated by forge uicheck
  design/visual, and both Pages deployments (GitHub Pages gets both pages,
  GitLab Pages gets the status page only).
- ROADMAP.md: fix the stale v0.5.0 "Now" header (actual: v0.6.0), move the
  already-shipped embeddings tier and public-site redesign out of "Next"
  into a new "Shipped — 0.6.0" section, and trim the Playwright loop bullet
  to just its still-open remainder.
- ARCHITECTURE.md: add the three modules missing from the repo-layout
  component map (embed.js, ledger_read.js, taste.js) and note the
  public-site build (landing/, scripts/build-pages.mjs, static.yml,
  .gitlab-ci.yml).

Docs-only; no source changes.
@CodeWithJuber CodeWithJuber marked this pull request as ready for review July 8, 2026 05:06
@CodeWithJuber CodeWithJuber merged commit 0beea4a into master Jul 8, 2026
10 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.

2 participants