docs: comprehensive README + new implementation-phase ADRs #17
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "docs/comprehensive-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Comprehensive documentation update
1. README rewrite
The old README still said "Planning repository... no application code yet". The backend is complete, deployed, and serving traffic.
The new 7.6 KB README covers: project description, current status, feature list, architecture, domain model, technology, repo structure, API endpoint reference, response envelope examples, local dev instructions, Docker deployment quick start, environment variables, documentation links, and CI/CD overview.
2. New ADRs (0013–0016)
Four decisions were made during implementation but never recorded as ADRs. Cross-checked the existing ADRs (0001–0012) against the actual code and identified the gaps:
3. ADR index restructured
Split the ADR index into Planning phase (0001–0012) and Implementation phase (0013+) sections, making the temporal distinction clear.
Existing ADRs assessment
The original 12 ADRs remain accurate — no corrections needed. They captured the intent before implementation, and the code faithfully follows them. The only divergence is ADR 0008 (boolean tree search) which ADR 0016 now documents as a deliberate simplification.
Summary
Summary
Coverage
DoujinManager.ApplicationCore - 84.8%
DoujinManager.Infrastructure - 91.6%
pshot
DoujinManager.RestAdapter - 83.9%
E5CB12CEAC5BBBEA65844E1C05F9ADA4DA38B848075C41304FC6A1ABF77__ValidationAttr
ibuteCache
DoujinManager.Server - 16.7%
docs: comprehensive README reflecting current server stateto docs: comprehensive README + new implementation-phase ADRs🤖 Hermes automated review: minor comments
Reviewed the full diff (6 files, +378/−21): README rewrite, four new ADRs (0013–0016), and ADR-index restructure. Documentation-only change — no source code touched, so no build/runtime risk.
Static security scan: clean (markdown only; no secrets, shell injection, eval/exec, or SQL injection in added lines).
Minor (non-blocking) notes
ADR count is now stale in the README's own docs list —
README.md→ Documentation section:- [Decision Records](docs/adr/) — 12 ADRs covering tech choices, auth, domain model, storageThis same PR adds ADRs 0013–0016, bringing the directory total to 16. The link points at the whole
docs/adr/directory, so "12 ADRs" is internally inconsistent with the rest of the PR. Suggest updating to "16 ADRs" (or "0001–0016").Test-count claim not verifiable from CI evidence —
README.md→ What works:- 234 unit and integration testsThe CI coverage comment reports line/branch coverage but not a test count, so I couldn't independently confirm "234". Likely fine, but worth a quick
dotnet testcross-check if the exact number matters. Not blocking.What looks good
VACUUM INTObackup with timestamped code-generated filenames + regex-validated delete,SQLitePCLRaw.bundle_e_sqlite3pin, flat AND search model). ADR 0016's honest documentation of the divergence from ADR 0008's boolean-tree plan is exactly the right move.Verification
0aa6341f(forgejo-actions coverage comment #293 current: line 83.5%, branch 49.4%, generated 06/29 11:59 UTC — after the head commit). ci.yml posts coverage only on successful build+test, so build+test passed. Local build/test skipped per CI-evidence policy (and this is a docs-only PR).This is an automated review comment, not a formal Forgejo review approval — the current MCP integration cannot create review approval states.
Automated daily review. I never merge PRs.
I would avoid adding anything like the test case counts to the general readme. 1. Who cares about the exact number tests? 2. It would create the constant need to be updated or else it is extremely quickly outdated.
Both points addressed in
48b4263:@bjoern — removed the "234 unit and integration tests" line entirely. You're right, the exact count is meaningless to README readers and goes stale the moment a test is added or removed.
Automated review — fixed the ADR count from "12 ADRs" to "16 ADRs" to reflect the four new ones added in this PR.