Skip to content

VNClagoon+ Documentation

One source for the VNClagoon+ suite. These topics — the user manual, the in-product help, and any partner or onboarding material — are generated from the same Markdown.

Path Contents
content/shared/ Cross-product topics: sign-in, sovereignty, suite integration
content/index.mdx This landing page
templates/ The four Diátaxis topic templates — always start from these
style-guide.md VNClagoon+ terminology, tone and structure rules
CONTRIBUTING.md Docs-as-code workflow
products.yaml Manifest: which product repos feed this site, and in what order
scripts/ sync-docs.mjs (assemble) and validate-frontmatter.mjs
src/content/docs/ Generated by the sync script — never edit by hand

Product topics live with their product, in <repo>/docs/user/. The hub aggregates them at build time. See products.yaml.

Terminal window
npm install
npm run sync # assemble content/ + product docs into src/content/docs/
npm run validate # frontmatter schema check
npm run dev # http://localhost:4321
  • One topic answers one question.
  • Product topics live in the product repo, and change in the same PR as the feature.
  • Never duplicate shared content — include it from content/shared/.
  • title and description are frontmatter; there is no H1 in the body.
  • Every topic names an owner, an id that never changes, and a status.