docs
This commit is contained in:
parent
c99af18ae4
commit
ca565e2530
26 changed files with 209 additions and 104 deletions
|
|
@ -4,9 +4,30 @@ slug: /
|
|||
|
||||
# scholarr Documentation
|
||||
|
||||
- Start here: `docs/deploy/quickstart.md`
|
||||
- Runtime config: `docs/reference/environment.md`
|
||||
- API contract: `docs/reference/api_contract.md`
|
||||
- Domain boundaries: `docs/architecture/domain_boundaries.md`
|
||||
- Ops runbooks: `docs/ops/`
|
||||
- Frontend theme inventory: `docs/frontend/theme_phase0_inventory.md`
|
||||
This documentation is organized for both users and developers.
|
||||
|
||||
## For Users
|
||||
|
||||
- [User Overview](./user/overview.md)
|
||||
- [Getting Started](./user/getting-started.md)
|
||||
|
||||
## For Operators
|
||||
|
||||
- [Operations Overview](./operations/overview.md)
|
||||
- [Scrape Safety Runbook](./operations/scrape-safety-runbook.md)
|
||||
- [Database Runbook](./operations/database-runbook.md)
|
||||
- [Migration Rollout Checklist](./operations/migration-checklist.md)
|
||||
|
||||
## For Developers
|
||||
|
||||
- [Developer Overview](./developer/overview.md)
|
||||
- [Local Development](./developer/local-development.md)
|
||||
- [Architecture Boundaries](./developer/architecture.md)
|
||||
- [Contributing](./developer/contributing.md)
|
||||
- [Frontend Theme Inventory](./developer/frontend-theme-inventory.md)
|
||||
|
||||
## Reference
|
||||
|
||||
- [Reference Overview](./reference/overview.md)
|
||||
- [API Contract](./reference/api-contract.md)
|
||||
- [Environment Reference](./reference/environment.md)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue