Skip to content

Stub CLAUDE.md; move internals to docs/internals.md#116

Merged
Jammy2211 merged 1 commit into
mainfrom
feature/claude-md-stub
Jul 8, 2026
Merged

Stub CLAUDE.md; move internals to docs/internals.md#116
Jammy2211 merged 1 commit into
mainfrom
feature/claude-md-stub

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

Same surgery as PyAutoLabs/PyAutoHeart#33: CLAUDE.md (~230 lines, the single largest involuntary context load in the organism — auto-injected on any file read here) becomes a 9-line stub → AGENTS.md; internals move to docs/internals.md (on-demand); the never-rewrite-history block moves to AGENTS.md. Tests pass.

Part of the organism token-efficiency roadmap (item 2).

🤖 Generated with Claude Code

CLAUDE.md is auto-injected into agent context on first file read in this repo
— at ~230 lines it was the largest involuntary context load in the organism.
It is now a 9-line stub pointing at AGENTS.md (matching PyAutoBrain/PyAutoHeart);
the internals (autobuild CLI, pre-build steps, workspace structure, configs,
release.yml) move to docs/internals.md, read on demand. The
never-rewrite-history safety block moves to AGENTS.md so it stays in the
always-read path.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 8, 2026 10:22
@Jammy2211 Jammy2211 merged commit 558d862 into main Jul 8, 2026
@Jammy2211 Jammy2211 deleted the feature/claude-md-stub branch July 8, 2026 10:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR restructures repository guidance docs to reduce default context load: CLAUDE.md becomes a short pointer, detailed pipeline internals move to docs/internals.md (on-demand), and the “never rewrite history” policy is relocated into AGENTS.md.

Changes:

  • Add docs/internals.md containing detailed operational/internal pipeline documentation.
  • Replace the previously long CLAUDE.md with a short stub that points to AGENTS.md and docs/internals.md.
  • Update AGENTS.md to point to the new internals doc and include the “Never rewrite history” rules.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/internals.md New on-demand internal documentation for the build pipeline and repo operations.
CLAUDE.md Reduced to a minimal entrypoint that redirects to AGENTS.md and docs/internals.md.
AGENTS.md Updated references to internals location and now contains the history-rewrite prohibition.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/internals.md
Comment on lines +1 to +5
# PyAutoBuild — internals

Operational detail for working **inside** this repo: the `autobuild` CLI, the
pre-build steps, workspace folder structure, config files, and `release.yml`.
What PyAutoBuild *is* and the Brain/Heart/Build boundary live in
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.

2 participants