docs
This commit is contained in:
parent
c99af18ae4
commit
ca565e2530
26 changed files with 209 additions and 104 deletions
29
README.md
29
README.md
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
Self-hosted scholar tracking with a single app image (API + frontend).
|
||||
|
||||
[](https://github.com/JustinZeus/scholar-scraper/actions/workflows/ci.yml)
|
||||
[](https://github.com/JustinZeus/scholarr/actions/workflows/ci.yml)
|
||||
[](https://hub.docker.com/r/justinzeus/scholarr)
|
||||
[](https://hub.docker.com/r/justinzeus/scholarr)
|
||||
|
||||
|
|
@ -35,32 +35,11 @@ Open:
|
|||
|
||||
## Documentation
|
||||
|
||||
Primary docs live under `docs/`.
|
||||
Complete documentation is published at:
|
||||
|
||||
- Index: `docs/README.md`
|
||||
- Deploy and dev workflow: `docs/deploy/quickstart.md`
|
||||
- Environment reference: `docs/reference/environment.md`
|
||||
- API contract and payload conventions: `docs/reference/api_contract.md`
|
||||
- Architecture and domain boundaries: `docs/architecture/domain_boundaries.md`
|
||||
- Scrape safety runbook: `docs/ops/scrape_safety_runbook.md`
|
||||
- DB backup/restore/integrity runbook: `docs/ops/db_runbook.md`
|
||||
- Migration rollout checklist: `docs/ops/migration_checklist.md`
|
||||
- Frontend theme inventory: `docs/frontend/theme_phase0_inventory.md`
|
||||
- Contributing policy: `docs/contributing.md`
|
||||
- https://justinzeus.github.io/scholarr/
|
||||
|
||||
## Docs Site (Docusaurus)
|
||||
|
||||
Docusaurus source lives in `website/` and consumes markdown from `docs/`.
|
||||
|
||||
Local build:
|
||||
|
||||
```bash
|
||||
cd website
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
GitHub Pages deploy is automated via `.github/workflows/docs-pages.yml`.
|
||||
Source markdown and docs tooling live under `docs/`.
|
||||
|
||||
## Quality Gates
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue