Skip to content

docs(claude): slim CLAUDE.md to orientation+behavior; move niche sections to docs/#709

Merged
Dumbris merged 1 commit into
mainfrom
docs/lean-claude-md
Jun 18, 2026
Merged

docs(claude): slim CLAUDE.md to orientation+behavior; move niche sections to docs/#709
Dumbris merged 1 commit into
mainfrom
docs/lean-claude-md

Conversation

@Dumbris

@Dumbris Dumbris commented Jun 18, 2026

Copy link
Copy Markdown
Member

Why

CLAUDE.md is loaded into every Claude Code session and every Paperclip agent heartbeat. At 779 lines / ~40KB (~11K tokens) it was the single largest fixed item in the per-heartbeat instruction tax, and ~70% of it just duplicated docs/ (nearly every section ended with "See docs/…").

What

Slim CLAUDE.md to 155 lines / ~11KB (~3K tokens) — a 72% cut — keeping it as orientation + behavior only, with the reference detail pointed to docs/.

  • Moved to docs/development/ (linked from CLAUDE.md): web-ui-verification.md (Playwright sweep + HTML report), macos-tray.md (tray build + mcpproxy-ui-test), server-edition-multiuser-auth.md (Spec 024 config/endpoints).
  • Compacted the CLI / REST-endpoint / health-status / sensitive-data sections to short summaries + doc links.
  • Deleted the auto-generated ## Active Technologies (~45 near-identical lines) and ## Recent Changes stubs.
  • Fixed a stale linter note: CI uses golangci-lint v2 with .github/.golangci.yml (stricter than the local v1.x scripts/run-linter.sh).
  • Patched .specify/scripts/bash/update-agent-context.sh so ## Active Technologies no longer regrows on every speckit.plan run (clears new_tech_entries; ## Recent Changes already self-caps at 2).
  • Preserved all behavioral directives verbatim: Autonomous Operation Constraints (zero-interruption, TDD mandate, stop conditions), edition/build rules, security defaults.

Impact

~8K fewer tokens per session and per Paperclip heartbeat, with zero loss of agent-relevant info — everything removed is either auto-generated noise or a doc one click away.

No code changes; no behavior change for the app.

…ions to docs/

Cuts the per-session/per-heartbeat instruction tax (CLAUDE.md is loaded into
every Claude Code session and every Paperclip agent heartbeat). 779 -> 155
lines / 40KB -> 11KB by moving reference-heavy sections into docs/ and pointing
to them, deleting auto-generated noise, and fixing a stale linter note.

## Changes
- Move to docs/development/: web-ui-verification.md (Playwright sweep),
  macos-tray.md (tray build + ui-test), server-edition-multiuser-auth.md (Spec 024)
- Compact CLI/endpoint/health/sensitive-data sections to summaries + doc links
- Delete auto-generated 'Active Technologies' (~45 lines) + 'Recent Changes'
- Fix linter guidance: CI uses golangci-lint v2 (.github/.golangci.yml), stricter
  than the local v1.x scripts/run-linter.sh
- Patch .specify/scripts/bash/update-agent-context.sh so 'Active Technologies'
  no longer regrows on every speckit run (clears new_tech_entries)
- Preserve all behavioral directives (autonomy, TDD, stop conditions) verbatim
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 18, 2026

Copy link
Copy Markdown

Deploying mcpproxy-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2b13e22
Status: ✅  Deploy successful!
Preview URL: https://4ead8735.mcpproxy-docs.pages.dev
Branch Preview URL: https://docs-lean-claude-md.mcpproxy-docs.pages.dev

View logs

@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@github-actions

Copy link
Copy Markdown

📦 Build Artifacts

Workflow Run: View Run
Branch: docs/lean-claude-md

Available Artifacts

  • archive-darwin-amd64 (28 MB)
  • archive-darwin-arm64 (25 MB)
  • archive-linux-amd64 (16 MB)
  • archive-linux-arm64 (14 MB)
  • archive-windows-amd64 (28 MB)
  • archive-windows-arm64 (25 MB)
  • frontend-dist-pr (0 MB)
  • installer-dmg-darwin-amd64 (21 MB)
  • installer-dmg-darwin-arm64 (19 MB)

How to Download

Option 1: GitHub Web UI (easiest)

  1. Go to the workflow run page linked above
  2. Scroll to the bottom "Artifacts" section
  3. Click on the artifact you want to download

Option 2: GitHub CLI

gh run download 27736063856 --repo smart-mcp-proxy/mcpproxy-go

Note: Artifacts expire in 14 days.

@Dumbris Dumbris merged commit 060fd75 into main Jun 18, 2026
38 checks passed
@Dumbris Dumbris deleted the docs/lean-claude-md branch June 18, 2026 04:37
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