gabriel / muse public
chore BREAKING docs task/docs-cleanup #1 / 1
AI Agent gabriel · 116 days ago · May 19, 2026 · Diff

chore(docs): delete ephemeral planning docs, move white paper, refresh docs/README

- Delete out/docs.md (auto-generated artifact, 3 lines, zero content) - Delete docs/cache-reorganization-plan.md (completed planning doc) - Move WHITE_PAPER.md → docs/WHITE_PAPER.md (all docs belong in docs/) - docs/README.md: bump version v0.1.3 → v0.2.0, add white paper to nav, expand directory map with all tracked files, fix testing standards to use muse code test and per-file pytest invocations

sha256:63d53804baeb6f4f54a18df409a8396be2c508bd7aab73aeba8c10a219d45549 sha
sha256:904e14c9d2cec8851a76b10eb21a9851aa04042ad7ae0d208e304d3d2b0c3874 parent
+2 ~9 −35 symbols
sha256:019d8d5229c3136f0d4874b28d74def40ba6b2d09bfe207bdc06f61fec503eb4 snapshot
+2
symbols added
~9
symbols modified
−35
symbols removed
0
dead code introduced
Semantic Changes 46 symbols
− out
~ docs/cache-reorganization-plan.md .md 33 symbols removed
− Cache Reorganization Plan section Cache Reorganization Plan L1–572
− Cache inventory section Cache inventory L16–33
− table@L18 section table@L18 L18–26
− Docstring standard section Docstring standard L180–227
− code[python]@L185 variable variable code[python]@L185 L185–224
− Migration for existing repos section Migration for existing repos L567–572
− Motivation section Motivation L6–16
− Phases section Phases L227–567
− Phase 1 — Infrastructure + test_history ✅ section Phase 1 — Infrastructure + test_history ✅ L229–241
− Phase 2 — stat_cache ✅ section Phase 2 — stat_cache ✅ L241–253
− Phase 3 — symbolcache, callgraphcache, implicitedgecache ✅ section Phase 3 — symbolcache, callgraphcache, implicitedgecache ✅ L253–265
− Phase 4 — invariants cache ✅ section Phase 4 — invariants cache ✅ L265–310
− Phase 5 — Fix concurrent write race (Pattern B → A) ✅ section Phase 5 — Fix concurrent write race (Pattern B → A) ✅ L310–354
− code[python]@L323 variable variable code[python]@L323 L323–343
− Phase 6 — Shared MsgpackCache base class ✅ class section Phase 6 — Shared MsgpackCache base class ✅ L354–567
− MsgpackCache ABC interface section MsgpackCache ABC interface L361–463
− code[python]@L363 variable variable code[python]@L363 L363–462
− Subclass changes class section Subclass changes L463–477
− py section Test file: tests/test_cache_base.py L477–547
− code[python]@L481 variable variable code[python]@L481 L481–495
− from_root — wiring in callers section from_root — wiring in callers L547–567
− code[python]@L551 variable variable code[python]@L551 L551–561
− Seven testing tiers section Seven testing tiers L73–180
− Tier 1 — Unit section Tier 1 — Unit L83–95
− Tier 2 — Integration section Tier 2 — Integration L95–106
− Tier 3 — End-to-end section Tier 3 — End-to-end L106–119
− Tier 4 — Stress section Tier 4 — Stress L119–133
− Tier 5 — Data integrity section Tier 5 — Data integrity L133–151
− Tier 6 — Performance section Tier 6 — Performance L151–164
− Tier 7 — Security section Tier 7 — Security L164–180
− Write pattern taxonomy section Write pattern taxonomy L33–52
− py) section mkstemp prefixes registered in _MUSE_TEMP_PREFIXES (repo.py) L52–73
− code[python]@L57 variable variable code[python]@L57 L57–67
− out/docs.md .md
~ docs/README.md .md 2 symbols added, 2 symbols removed, 9 symbols modified
~ code@L123
~ table@L145
~ table@L156
~ table@L177
− code@L42 variable variable code@L42 L42–116
− code[bash]@L191 variable variable code[bash]@L191 L191–201
+ code@L43 variable variable code@L43 L43–129
+ code[bash]@L204 variable variable code[bash]@L204 L204–214
~ Muse Documentation
~ Directory Map
~ Quick Navigation
~ table@L11
~ Testing Standards
~ docs/WHITE_PAPER.md .md moved from WHITE_PAPER.md
← Older Oldest on task/docs-cleanup
All commits
Newer → Latest on task/docs-cleanup

0 comments

No comments yet. Be the first to start the discussion.

To add a comment, use the Muse CLI: muse hub commit comment sha256:63d53804baeb6f4f54a18df409a8396be2c508bd7aab73aeba8c10a219d45549 --body "your comment"