Skip to content

docs: Move the per-ADR index out of CLAUDE.md into adr/README.md#635

Merged
xerial merged 1 commit into
mainfrom
docs/slim-claude-md-adr-index
Jul 6, 2026
Merged

docs: Move the per-ADR index out of CLAUDE.md into adr/README.md#635
xerial merged 1 commit into
mainfrom
docs/slim-claude-md-adr-index

Conversation

@xerial

@xerial xerial commented Jul 6, 2026

Copy link
Copy Markdown
Member

Why

CLAUDE.md is loaded into every Claude session, and the Architecture decisions section had grown into a full index with multi-sentence summaries per ADR — a large fixed context cost on every task.

What

  • New adr/README.md holds the detailed index (the "read before touching X" summaries), unchanged in content.
  • CLAUDE.md's Architecture decisions section is now a short pointer to adr/ + adr/README.md, keeping the convention (consult the relevant ADR before modifying a covered area; add an index entry with each new ADR).

🤖 Generated with Claude Code

CLAUDE.md is loaded into every Claude session, so the growing multi-sentence
ADR summaries were eating context budget on every task. Keep a short pointer
in CLAUDE.md and load the detailed when-to-read index from adr/README.md on
demand instead.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@github-actions github-actions Bot added the doc Improvements or additions to documentation label Jul 6, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the documentation by moving the detailed list of Architecture Decision Records (ADRs) from CLAUDE.md into a new dedicated index file at adr/README.md. CLAUDE.md has been updated to reference this new index file instead. There are no review comments, and I have no additional feedback to provide.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@xerial xerial merged commit 6d90846 into main Jul 6, 2026
15 checks passed
@xerial xerial deleted the docs/slim-claude-md-adr-index branch July 6, 2026 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant