Skip to content

docs: sync after #394 (site page count, site assembly inputs) - #399

Closed
Sev7eNup wants to merge 1 commit into
mainfrom
docs/auto-sync-2026-09-21
Closed

Sev7eNup wants to merge 1 commit into
mainfrom
docs/auto-sync-2026-09-21

Conversation

@Sev7eNup

Copy link
Copy Markdown
Owner

What & why

Automated documentation-drift sync for pull requests that landed in the last 26 hours. One PR was
in the window: #394 (Serve the project website from real addresses and harden its hosting).

Two claims went stale against main and are corrected here. Both were verified against the
checked-out code, not inferred from the diff.

Doc Claim Reality on main Caused by
README.md (×2) documentation site has 43 pages per language 44 — nav.ts lists 44 paths and content/de / content/en hold 44 .md files each #394 added getting-started/live-demo.md + its nav entry
CONTRIBUTING.md assemble:site runs "from the two finished builds"; output layout lists root / docs/ / media/; preview:site "runs both builds" scripts/assemble-site.mjs requires three builds (dist-site, dist, dist-demo) plus pages-media, and writes demo/ as well; preview:site runs build, build:site and build:demo #394 made the browser demo a required assembly input but left the prose at two builds

The page count is confirmed by comparing the two commits directly: content/en held 43 .md
files at d4cf015 (the merge base) and holds 44 at 62341af.

The CONTRIBUTING correction also records that every assembly input is required — assemble-site.mjs
says in its own comment that an optional input "would let a deploy publish a site that silently
keeps the previous demo", and CLAUDE.md already states this. CONTRIBUTING was the one surface
that did not.

How

Text-only. No code, no config, no test changes.

Testing

Nothing executable changed, so no suite applies. The two figures are derived from the repository
rather than asserted by a guard:

  • 44 = grep -oE "path: '[^']+'" src/nodepilot-docs-ui/src/data/nav.ts | wc -l, matching
    find src/nodepilot-docs-ui/content/{de,en} -name '*.md' | wc -l (44 each).
  • The assembly inputs are read off REQUIRED / cpSync in src/nodepilot-docs-ui/scripts/assemble-site.mjs
    and the preview:site script in src/nodepilot-docs-ui/package.json.

DocumentationCountsTests does not pin the page count, so no guard pattern needed updating. Its
existing rows (MCP tools 102, activity types 27, skins 10, 234 Vitest files, 77 E2E specs) were
re-checked against the code and all still match — no drift there.

  • Docs updated (README / CLAUDE.md / docs/ / docs-ui content/de/ and content/en/) if behavior or config changed
  • Branched off main; no direct commits to main

Not applied here

Findings from #394 that needed a human decision rather than an objective correction were filed
separately as a docs-drift issue, not fixed in this PR — chiefly that the demo's guided walkthrough
(demo/ui/tour.ts, covered by e2e-demo/guided-tour.spec.ts) is absent from the live-demo doc
page in both languages and has no entry in the E2E catalogue.


Generated by Claude Code

#394 added content/{de,en}/getting-started/live-demo.md and its nav entry,
taking the documentation site from 43 to 44 pages per language. README named
the old figure in both places it cites the site.

The same PR made the browser demo a required input of assemble-site.mjs, but
CONTRIBUTING still described the assembly as running over two builds and listed
an output layout without demo/. Named the third build and the demo output, and
recorded that every input is required.
@Sev7eNup

Copy link
Copy Markdown
Owner Author

Superseded by #403, which carried the same sync on top of the copy-editing pass in #402. Everything this PR changes is already on main: the 44-page count in both README spots, the npm run build:demo bullet, and the three-build wording for assemble:site and preview:site. Merging it now would reinstate the pre-#402 phrasing of those paragraphs, so closing instead.

@Sev7eNup Sev7eNup closed this Sep 22, 2026
@Sev7eNup
Sev7eNup deleted the docs/auto-sync-2026-09-21 branch October 9, 2026 08:53
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