VidArch Docs
Developers

Maintaining the documentation

Modify this site without desynchronizing the product instructions.

The documentation lives in a separate repository from the product so that it can be published independently. Its content must nevertheless remain aligned with README.md, .env.example, docker-compose.yml, SECURITY.md and the VidArch code.

Locally

npm ci
npm run dev

The default port is 2499. Set VIDARCH_DOCS_PORT if VidArch is already using this port. The npm run dev -- --lan option is reserved for voluntary testing on the local network.

Before delivery

npm run check:content
npm run check:links
npm run lint
npm run typecheck
npm run build

Examples must use fictitious domains, contain no secrets, and clearly indicate destructive operations. Any new page must be added to the meta.json of its section.

On this page