fraqtal/agentic-dev
Template
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Initial commit

Browse Source
This commit is contained in:
fraqtal
2026-07-12 08:15:46 +00:00
commit ee0fec0691
1397 changed files with 127242 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
docs/work/epics/compliance-docs-scaffolds/06-doc-wiring/_story.md Normal file
View File

@@ -0,0 +1,46 @@
---
id: 06-doc-wiring
epic: compliance-docs-scaffolds
title: Wire compliance docs into CLAUDE.md, README, and glossary
type: technical-story
status: done
feature: ~
depends-on: [05-compliance-overview]
blocks: []
created: 2026-05-20T12:00:00Z
updated: 2026-05-20T12:52:53.917Z
---
## Goal
Complete the one-directional wiring of Epic D's new documents into the three shared navigation surfaces: add a "Policy templates" section to `docs/compliance/README.md`, add four new glossary entries to `docs/glossary.md`, and add a `compliance-overview.md` pointer to CLAUDE.md's "Read First" section.
## Why
Without these changes, `compliance-overview.md` is orphaned from the primary AI navigation entry point (CLAUDE.md), the policy templates have no discovery path in `docs/compliance/`, and the `[FILL IN:]` marker convention has no canonical glossary definition. The PRD specifies these as the final wiring step, after all new documents exist so links resolve.
## Done when
- `docs/compliance/README.md` has a "Policy templates" section that explains: the `docs/compliance/templates/` directory, the copy-to-`compliance/` workflow, the `[FILL IN:]` convention, and the `grep -rn '\[FILL IN:' compliance/` verification one-liner.
- `docs/glossary.md` has four new entries: `pre-launch compliance checklist`, `compliance overview`, `fill-in template`, `[FILL IN:] marker`.
- CLAUDE.md "Read First" lists `compliance-overview.md` (with path and one-line description matching the existing entries' style).
- No existing content in any of the three files is removed or modified.
- Every relative Markdown link added resolves to an existing file.
- `pnpm lint && pnpm typecheck && pnpm test && pnpm conformance && pnpm fallow:audit` all pass.
## In scope
- `docs/compliance/README.md` — add "Policy templates" section.
- `docs/glossary.md` — add 4 entries.
- `CLAUDE.md` — add `compliance-overview.md` pointer to "Read First".
## Out of scope
- Any changes to `docs/guides/compliance-overview.md` or the templates (they are complete by the time this story runs).
- Any changes to the existing compliance guides (`dsr.md`, `consent.md`, etc.).
- Broadening `docs/compliance/README.md` beyond the generator schema + policy template scope.
## Tasks
- [x] Add a "Policy templates" section to `docs/compliance/README.md` (explaining the `docs/compliance/templates/` directory, copy-to-`compliance/` workflow, `[FILL IN:]` convention, and the `grep -rn '\[FILL IN:' compliance/` one-liner) and add four glossary entries (`pre-launch compliance checklist`, `compliance overview`, `fill-in template`, `[FILL IN:] marker`) to `docs/glossary.md`; commit as `docs(compliance): document policy template convention in README and glossary`.
- [x] Add `docs/guides/compliance-overview.md` to the "Read First" section of `CLAUDE.md` with a one-line description matching the existing entries' style; commit as `docs(core): add compliance-overview.md to CLAUDE.md Read First`.