trex/portfolio-hub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor docs into technical specs

Browse Source
This commit is contained in:
genichin
2026-04-13 23:20:25 +09:00
parent f3c870553d
commit 256b3709a0
19 changed files with 1713 additions and 2087 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -69,7 +69,7 @@ your-domain.com {
}
```
See **[docs/deployment.md](docs/deployment.md)** for a full guide covering:
See **[docs/technical/deployment-and-operations.md](docs/technical/deployment-and-operations.md)** for a full guide covering:
- Caddy installation on Linux/Ubuntu
- CORS configuration (`PORTFOLIOHUB_ALLOWED_ORIGINS`)
@@ -152,10 +152,10 @@ To keep implementation and specification documents in sync, this repository prov
Rules enforced:
- If files under `app/` change, `docs/portfoliohub-spec.md` must be updated in the same commit/PR.
- If files under `app/api/` or `app/schemas/` change, `docs/api-examples.md` must be updated in the same commit/PR.
- If files under `migrations/versions/` change, `docs/db-schema-spec.md` must be updated in the same commit/PR.
- Changed migration revision IDs must appear in `docs/db-schema-spec.md`.
- If files under `app/` change, at least one `docs/technical/` document must be updated in the same commit/PR.
- If files under `app/api/` or `app/schemas/` change, `docs/technical/api-contracts.md` must be updated in the same commit/PR.
- If files under `migrations/versions/` change, `docs/technical/persistence-and-migrations.md` must be updated in the same commit/PR.
- Changed migration revision IDs must appear in `docs/technical/persistence-and-migrations.md`.
Enable local pre-commit check: