scholarr/docs/README.md

Documentation Index

This directory contains both docs content and docs tooling.

Audience-Based Structure

• docs/user/: onboarding and usage-oriented docs for self-hosters.
• docs/operations/: runbooks and rollout checklists for ongoing operations.
• docs/developer/: architecture, contribution standards, and local development workflows.
• docs/reference/: canonical API and environment contracts.

Docs Tooling

• docs/website/: Docusaurus app used to publish docs to GitHub Pages.

Recommended Reading Paths

• Users: docs/user/getting-started.md
• Operators: docs/operations/overview.md
• Developers: docs/developer/overview.md
• Contract consumers: docs/reference/overview.md

Published site: https://justinzeus.github.io/scholarr/