Skip to content

Refactor CLAUDE.md for progressive disclosure - #18

Merged
serradura merged 1 commit into
mainfrom
chore/claude-md
Jan 29, 2026
Merged

serradura merged 1 commit into
mainfrom
chore/claude-md

Conversation

@serradura

@serradura serradura commented Jan 29, 2026

Copy link
Copy Markdown
Member

Summary

  • Slim root CLAUDE.md down to essentials: project description, commands, lint rule, and links
  • Extract detailed conventions into .claude/docs/ (testing, documentation, release & versioning)
  • Remove redundant sections the agent can discover from code (Architecture/Core Classes, ASDF commands)

Test plan

  • Verify Claude Code picks up the root CLAUDE.md and follows linked convention files
  • Confirm no instructions were lost (all content preserved or intentionally removed)

Extract specialized conventions into .claude/docs/ files so the root
CLAUDE.md stays minimal (commands, lint, links) and detailed guidance
loads on-demand:

- .claude/docs/testing.md
- .claude/docs/documentation.md
- .claude/docs/release-and-versioning.md

Removed redundant sections (Architecture/Core Classes, ASDF commands,
meta intro line) that the agent can discover from the code itself.
@serradura
serradura merged commit f37bc11 into main Jan 29, 2026
9 checks passed
@serradura
serradura deleted the chore/claude-md branch January 29, 2026 13:51
@serradura serradura self-assigned this Jan 29, 2026
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