US09-05: Automate Documentation Acceptance
This commit is contained in:
18
README.md
18
README.md
@@ -4,6 +4,24 @@ Integrated, restart-safe photo analysis, duplicate review, metadata, upload, and
|
||||
archive workflow. Planning lives in `INTEGRATED_PIPELINE_CONCEPT.md` and
|
||||
`delivery_backlog/`.
|
||||
|
||||
## Documentation
|
||||
|
||||
The manuals live in [`docs/`](docs/index.md) and are the same files the running
|
||||
application serves at `/app/#/docs`:
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| [Overview](docs/overview.md) | what it does and the rules it will not break |
|
||||
| [Installation and operations](docs/installation.md) | host and container install, every setting, backup and restore, every refusal |
|
||||
| [A guided first pass](docs/first-pass.md) | one library from scan to verified upload |
|
||||
| [The stages](docs/index.md) | one illustrated page each, from inventory to archive |
|
||||
| [Errors and refusals](docs/errors.md) | every error code, cause, and remedy |
|
||||
| [Architecture](docs/architecture.md) | diagrams, module map, journals, invariants |
|
||||
|
||||
This README stays the repository's own notes — how the code is built, tested, and
|
||||
released. Anything an operator or a user needs belongs in `docs/`, and one gate
|
||||
(`python -m photo_pipeline docs-gate`) keeps those pages honest against the code.
|
||||
|
||||
## Application (`photo_pipeline`)
|
||||
|
||||
The target application lives in `photo_pipeline/` (FastAPI + SQLAlchemy + Alembic).
|
||||
|
||||
Reference in New Issue
Block a user