Files
fotospiel-app/docs/site
Codex Agent b866179521
Some checks failed
linter / quality (push) Has been cancelled
tests / ci (push) Has been cancelled
tests / ui (push) Has been cancelled
Remove missing doc from docs sidebar
2026-01-30 13:26:30 +01:00
..
2025-12-02 18:07:06 +01:00

Fotospiel Docs Site

This directory hosts a standalone Docusaurus project that renders everything inside the main /docs tree as a browsable internal website. Keeping the static-site tooling here isolates all Node dependencies from the Laravel/Vite application.

Structure

  • ../ — existing Markdown sources (PRP, ops runbooks, etc.). These stay untouched.
  • ./package.json — dependencies and scripts for the docs site only.
  • ./docusaurus.config.js — points the docs plugin at path: '../' and excludes this site/ directory.
  • ./sidebars.js — auto-generates the sidebar from the folder hierarchy.
  • ./src/css/custom.css — brand overrides for the default theme.

Usage

cd docs/site
npm install
npm run start   # Dev server at http://localhost:3100
npm run build   # Outputs to docs/site/build
npm run serve   # Serves built assets for preview

Because routeBasePath is /, the docs front page is the PRP index (or whichever document you place at docs/README.md). Update nav/footer links in docusaurus.config.js as needed.

Deployment

  1. npm run build creates the static site under docs/site/build.
  2. Publish that directory to your static host (S3 + CloudFront, Dokploy static app, etc.).
  3. Automate via CI by running installs/builds only inside this folder so the main app pipeline remains unchanged.

If you add new Markdown files anywhere under /docs, they automatically appear in the sidebar. To hide files, add ignore patterns to include/exclude in docusaurus.config.js.