Skip to content

chore(docs): replace phase reports with ADRs and a doc policy - #30

Merged
santidev21 merged 1 commit into
mainfrom
docs/adr-and-doc-policy
Sep 30, 2026
Merged

santidev21 merged 1 commit into
mainfrom
docs/adr-and-doc-policy

Conversation

@santidev21

Copy link
Copy Markdown
Owner

What

Replaces session-narration docs with decision records and a documentation policy.

Why

Per-phase reports (PHASE_*_REPORT, REMEDIATION_REPORT_PHASE_0.5) narrate what was done; they are not decisions and nobody reads them. They also invited the AI to keep generating them.

Changes

  • Delete docs/PHASE_*_REPORT.md and docs/REMEDIATION_REPORT_PHASE_0.5.md
  • Rescue live content into docs/specs/business-rules.md (partial payments, split methods, monetary precision, roles, email)
  • Add docs/adr/ with 4 ADRs: token storage, framework baseline, monetary rounding, deployment topology
  • Add a Documentation Policy to AGENTS.md (allowed vs forbidden docs)
  • Update repo-auditor, docs/CICD.md, docs/AUDIT_2026-09.md, docs/PRODUCTION_AUDIT.md so nothing references deleted files
  • Neutralize the progress.md instruction in the containerize-aspnetcore skill

Notes

No code, tests or config touched. Fully reversible.

- Delete PHASE_*_REPORT, REMEDIATION_REPORT_PHASE_0.5 (session narration)
- Add docs/specs/business-rules.md rescuing the live rules from those reports
- Add docs/adr/ (token storage, framework baseline, monetary rounding, deployment)
- Add Documentation Policy to AGENTS.md; forbid phase reports and progress logs
- Update repo-auditor, CICD and audit references to the surviving docs
- Drop the progress.md/checklist instruction from the containerize skill
@santidev21
santidev21 merged commit ac93a4f into main Sep 30, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant