Skip to content
DP-DOCSReviewed · 2026-11-19Desktop 1.8 · Companion 1.1.1Lire en français

Maintain this reference ​

A reference tied to code ​

documentation/topics.mjs defines stable IDs, routes, titles, groups and sources. French lives at the root; English under /en/ with matching routes. DP-… IDs let readers cite topics independently of translated titles. Every page shows review date, covered components and sources.

For a changed rule: read its module and tests, update the French page and English counterpart, check examples, add or supersede an ADR when needed. Review dates indicate human content verification; they must not advance automatically on every build.

Author and verify ​

sh
npm --prefix documentation ci --ignore-scripts
npm --prefix documentation run dev
npm --prefix documentation run verify

The build produces .work/docs-site. The portable documentation server serves compiled files only, on loopback, read-only. Use local HTTP: opening index.html directly through file:// is not the supported search/navigation workflow.

The validator checks counterparts, metadata, source paths, internal links and version consistency. VitePress checks links during compilation. Server tests cover reads, HEAD, rejected methods and path traversal. Visual inspection complements those checks for search, language switching and small windows.

Editorial conventions ​

Separate current behavior, assumptions and future proposals. Always state a threshold's unit and scope. Do not translate API keys. Prefer a calculable synthetic example to a personal screenshot. Never label estimated profit as realized. Maintain site-relative links and precise code references.

Structural parity does not prove translation accuracy: reviewers compare meaning and numeric values. Update both pages in the same PR. When changing routes, add an explicit redirect and verify old links before removal.

Code evidence links are pinned to the immutable documentation tag (docs-v1.0.0); edit links deliberately follow main. Update the reference tag with each documentation version.

Deliver a portable handbook ​

After installing dependencies at the repository root and in documentation, run npm --prefix documentation run package. This verifies and builds the site, then creates a Windows x64 ZIP in artifacts/ with a local reader, checksum-verified official Node, notices and file manifest. Extract the complete ZIP, then open OPEN-DOCS.cmd. Content and search work offline; only external links require a connection. On Linux/macOS with Node installed, run node scripts/serve-docs.mjs site --open from the extracted folder.

A local-first advisor. Estimates stay visible.