Repository navigation
docs: restructure guides around the ADRs; retire the phase-ordered set - #148
Merged
Merged
Conversation
#98) docs/implementation-guides/ (numbered, build-order narrative, 14 of 16 files with no inbound links) becomes docs/guides/ with topic names and a reading-order index. Six guides are rewritten against the ADRs they explain — data-access (002/003/004/005), view-layer (017/029/009), auth-and-security (014/024/027/028/031, absorbing the old security overview), testing (023/032/021), performance (000/034/016), documentation (011/022/030/033) — with every task, path, env var, route and number verified against the code; foundation, tooling, routing, htmx, background-jobs and deployment are rewritten in place without the phase framing (Go 1.26, no Asynq/Redis, real server timeouts, the /patterns catalogue as the living reference, the ticker reaper and Actions cron as the two job mechanisms, the six workflows). The ADR template moves to docs/adr/TEMPLATE.md and gains the mandatory Enforcement block (ADR-033 §1 schema), a **Date** line, and the status vocabulary the record actually uses. docs/adr/README.md indexes all 35 ADRs with supersession/amendment links; docs/README.md maps the folders. ADR-011 gets an appended amendment recording the new locations and the canonical metadata format for ADR-035 onward (older ADRs untouched). Deleted as superseded or orphaned: 00-how-to-use (superseded by the constitution), 13-advanced (OTel/multi-region/CODEOWNERS that don't exist), 14-simplified-app (the demo is the simplified app), docs/product/ (PRD says single-tenant; mermaid shows Cloudflare Workers + Stripe; ci-config.txt is a 2025 workflow for `main`; directory-structure duplicates the README tree), docs/database/indexing_strategy (folded into data-access), docs/implementation-notes/ (completed logs). ux-overhaul-spec and demo-design-brief stay (linked from ADR-024 and the patterns handler) with their stale route/task/pattern-count lines fixed. workflow.md, architect role and the personalization guide point at the new template path; AGENTS.md regenerated. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Contributor
Performance Budget Check ✅Binary Size: 14.91 MB / 20 MB |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #98. Phase 2 of the 2026-09-30 docs health plan.
What changed
docs/implementation-guides/(numbered build-order narrative, 14 of 16 files with zero inbound links) →docs/guides/with topic names and a reading-order index./patternscatalogue is the living reference), background-jobs (ticker goroutine + Actions cron; Asynq/Redis gone), deployment (real timeouts, the six workflows).docs/adr/TEMPLATE.mdwith the mandatory## Enforcementblock, a**Date**line and the real status vocabulary.docs/adr/README.mdindexes all 35 ADRs with supersession/amendment links.docs/README.mdmaps the folders.00-how-to-use,13-advanced,14-simplified-app, all ofdocs/product/(PRD, Workers+Stripe mermaid, 2025 CI sample, directory tree),docs/database/(folded into data-access),docs/implementation-notes/.ux-overhaul-spec/demo-design-briefkept (linked from ADR-024 and the patterns handler); their stale route, task and pattern-count lines fixed.Net: 49 files, +1199 / −2518.
task cigreen locally; relative-link check 0 broken across 67 files.🤖 Generated with Claude Code