Skip to content

docs(readme): apply the 2026-10-04 claim decisions and structural sections (#58) - #77

Merged
amar-python merged 1 commit into
mainfrom
docs/readme-claims-2026-10-04
Oct 25, 2026
Merged

amar-python merged 1 commit into
mainfrom
docs/readme-claims-2026-10-04

Conversation

@amar-python

Copy link
Copy Markdown
Owner

Closes #58.

Applies the eight README claim decisions from 2026-10-04 and the three structural sections. The decisions are recorded in PR #76 (DECISIONS/2026-10-04-readme-claims-audit.md), and the verification is on #56.

Claim Decision Change
1.1 Audit log D: verify. Found true API table and naming note now say upload and deletion history. Per the record, "if true: fix API table description"
1.2 "Production-grade" Keep, risk accepted Unchanged
1.3 DB deployment D: verify Azure section matches Terraform: dev is a Container App (external_enabled = false); test, staging and prod are Flexible Server
2.1 Dev password B: REPLACE_ME Quick-start uses PGPASSWORD=REPLACE_ME and points to env.dev.example
2.2 Paths and ports A: generic defaults Port 5432 with a note for other ports. The Git Bash install path is removed, with a note that bash must be Git Bash, not WSL
3.1 Test counts A: by tier Evals: P 23, I 1, S 1, E 1. Vitest count corrected from 76 to 95 (the count on main)
3.2 FastAPI badge A: pinned Shows 0.140–0.141, matching fastapi>=0.140.7,<0.142.0
3.3 "ASDEFCON-aware" A, pending DID check Nothing to change: the phrase is not in the README on main. The DID alignment check stays open

Structural, add-only: Status, Known Limitations and For Reviewers sit at the top. Every statement in them was checked against the repo: workflow triggers, build/adapters/, api/auth.py, api/ratelimit.py, api/services/audit.py, ADR-0001 and VCRM BR-21/22.

Things to watch:

Checks: the DB-free pytest run gave 118 passed. All five open PRs from this session (#73, #74, #75, #76 and this one) merge together cleanly onto main.


Generated by Claude Code

…tions (#58)

Per DECISIONS/2026-10-04-readme-claims-audit.md and the #56 verification:
- 1.1 audit log is real: API table and naming note now describe upload
  and deletion history, not deletions only
- 1.2 'production-grade' kept (risk accepted)
- 1.3 Azure section matches Terraform: dev Container App, test/staging/prod
  Flexible Server
- 2.1 quick-start password is the REPLACE_ME sentinel
- 2.2 default port 5432, no machine-specific Git Bash path
- 3.1 eval and vitest counts broken down and corrected
- 3.2 FastAPI badge shows the pinned range
Adds Status, Known Limitations and For Reviewers at the top (add-only).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019YPoXzBSj89ZHgw7nfTmbB
@amar-python amar-python added this to the Docs, claims and reporting milestone Oct 25, 2026 — with Claude
@amar-python amar-python added the docs Documentation and records label Oct 25, 2026 — with Claude
@amar-python
amar-python merged commit 41f2f72 into main Oct 25, 2026
3 checks passed
@amar-python
amar-python deleted the docs/readme-claims-2026-10-04 branch October 27, 2026 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation and records

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Apply README edits (8 claim decisions plus 3 structural sections)

2 participants