docs

docs is a Fastify service that exposes curated documentation indexes from the local sitemap/ directory.

What it serves

• GET / for the route list
• GET /status for health, route count, generation timestamp, and refresh mode
• GET /api/:topic for the stored docs payload for that topic

The service boots from existing sitemap files, so runtime availability does not depend on live crawling succeeding in that moment.

Some sources are better handled as curated official route lists than as raw HTML crawling targets. That is intentional for docs sites that render most navigation client-side.

Runtime model

• Local and Docker runs both serve the checked-in/generated sitemap/*.json files immediately.
• Crawling is an explicit maintenance action, not a startup requirement.
• Set HOST if you want to bind somewhere other than 127.0.0.1.
• Set DOCS_REFRESH_ON_START=true only when you intentionally want boot-time regeneration.

Local run

npm install
npm start

Default local address: http://127.0.0.1:3000

Refresh stored docs

npm run refresh

That rebuilds the sitemap files from the configured project sources in src/projects.ts.

Docker run

docker compose up -d --build

Default Docker address: http://127.0.0.1:3002