Skip to content

Documentation

Manage the MkDocs documentation site, track page engagement, and moderate visitor comments.


MkDocs Management

From Docs (/app/docs):

  • View MkDocs build status and health
  • Browse the documentation file tree
  • Export landing pages to MkDocs as Jinja2 Material theme overrides
  • Configure documentation settings from MkDocs Settings (/app/docs/settings)

Documentation Analytics

Track how visitors interact with documentation pages using the MkDocs Material theme's custom analytics provider and navigation.tracking.

  • Navigation tracking — updates the browser URL as users scroll through sections, enabling section-level engagement tracking
  • Custom provider — integrates with any third-party analytics tool (Plausible, Umami, Google Analytics) via template overrides in docs/overrides/

Comments

Visitors can leave comments on documentation pages using a Gitea-backed comment system.

  • Anonymous posting — visitors can comment without creating an account
  • Gitea-backed — comments stored as Gitea issues (one issue per page) for version control and searchability
  • Moderation — admin panel at /app/docs-comments for approving, hiding, or deleting comments
  • OAuth login — optional Gitea OAuth for authenticated commenting
  • Per-page threads — each documentation page gets its own comment thread

Admin Routes

  • /app/docs — MkDocs management (file tree, config, build triggers)
  • /app/docs/settings — documentation configuration
  • /app/docs-comments — moderate documentation comments