SOC docs is a single SvelteKit documentation site that serves four guide collections:
- User Guide
- Administrator Guide
- Technical Guide
- Project Guide
The site is fully prerendered and deployed as static output.
- Node.js 22
- npm 10+
npm install
npm run devnpm run check
npm run build
npm run check:linksnpm run build runs SvelteKit production build and then generates the Pagefind index in build/pagefind.
Content lives under:
content/docs/<guide>/<NN-section>/<NN-page>.md
Examples:
content/docs/user/index.mdcontent/docs/user/10-getting-started/index.mdcontent/docs/user/10-getting-started/10-create-your-account.md
Number prefixes are used for nav order and stripped from the URL.
content/docs/user/10-getting-started/10-create-your-account.md- renders at
/docs/user/getting-started/create-your-account
Number in steps of 10 (10-, 20-, 30-, ...) so new pages can be inserted between existing
ones without renumbering the whole section.
---
title: Create Your Account
description: Set up a resident account and verify access.
status: stub
---Rules:
titleis requireddescriptionis requiredstatusis optional and defaults tocomplete- valid statuses:
stub,draft,complete
Store static images in:
static/images/docs/<guide>/<section>/...
Reference with absolute paths in markdown:
Screenshot guidance: capture at 2x device pixel ratio, export as webp, and keep the longest edge at or under 1600px.
Write internal links as absolute paths (/docs/user/getting-started/create-your-account).
npm run check:links verifies every internal href and src against the build output.
Pagefind is loaded lazily by the search modal and available in production builds.
The build includes:
/llms.txt/llms-full.txt
GitHub Actions workflow runs:
npm cinpm run checknpm run buildnpm run check:links