Repository navigation
Docs: CLAUDE.md becomes a short guide; design rationale moves to docs/design/ - #15
Merged
Merged
Conversation
…to docs/design/ CLAUDE.md was 1,605 lines and 118 KB — the second-largest file in a public repo, and an engineering journal rather than a guide. It is now what its first line promises: commands, layout, the scheduler table, the ten rules that hold everywhere, testing conventions, voice, and a table saying which design note to read before touching which module. Every rationale section moved verbatim into docs/design/, one file per area (agent-loop, guards, db, scheduler, reminders, morning, onboarding, checkin, sms, opening, scores-and-shows, page, profile, sources, weather, commute, time, shopping-and-flights), each opening with the modules it governs. Nothing was summarised away — those sections carry the incidents behind the code, which is the part worth keeping. The two example users named in the weather and repetition notes are now the same invented people the tests use. README points at docs/design/ for the reasoning and at CLAUDE.md for the short guide. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018QpUhnYC3U7KxF8QCeenfQ
CLAUDE.md stays the short guide; the morning-format and link-preview rationale moves into docs/design/morning.md and page.md. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
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.
Summary
Stage 4 of 4 (hygiene → package layout → test consolidation → docs split). Stacked on #14; merge #13, #14, then this.
CLAUDE.md was 1,605 lines / 118 KB — the second-largest file in a public repo, and an engineering journal rather than a guide. It is now 111 lines: commands, layout, the scheduler table, the ten rules that hold everywhere, testing conventions, voice, and a "read before touching" table mapping modules to design notes.
Every rationale section moved verbatim into
docs/design/— 18 files, one per area, each opening with the modules it governs. Nothing was summarised away; those sections carry the incidents behind the code. The two example users named in the weather and repetition notes are now the invented people the tests use.Test plan
###section of the old file is accounted for (the split script aborts on an unmapped heading)pytest -q— 1,430 passed (docs only; sanity)🤖 Generated with Claude Code
https://claude.ai/code/session_018QpUhnYC3U7KxF8QCeenfQ