Skip to content

docs: move Lessons Learned out of CLAUDE.md into docs/#153

Merged
blehnen merged 1 commit into
masterfrom
trim-claude-md-lessons
May 27, 2026
Merged

docs: move Lessons Learned out of CLAUDE.md into docs/#153
blehnen merged 1 commit into
masterfrom
trim-claude-md-lessons

Conversation

@blehnen
Copy link
Copy Markdown
Owner

@blehnen blehnen commented May 26, 2026

Summary

CLAUDE.md was 190 lines / ~37 KB. The Lessons Learned section accounted for ~66% of that and Claude Code began warning the file was too large to load as project context every turn.

  • Moved all 62 lesson bullets verbatim into docs/lessons-learned.md.
  • Replaced the inline block in CLAUDE.md with a one-line pointer.
  • No content lost — git diff shows pure relocation.

CLAUDE.md: 190 → 134 lines, 36.7 KB → 8.9 KB (76% smaller).

Pure docs change — no code, no tests, no build impact.

Test plan

  • Visual diff confirms 62 bullets moved verbatim
  • CodeRabbit review pass
  • Jenkins green (docs-only change, but the pipeline runs anyway)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Moved long engineering lessons and historical development notes into a dedicated reference document to improve organization, discoverability, and guidance on CI, dependency/versioning, testing patterns, transport integrations, and release workflows.
  • Chores

    • Streamlined the main documentation by consolidating technical insights and project history into a separate file for easier maintenance and navigation.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 690efc78-9130-42ca-a1f4-dfba2e4593dc

📥 Commits

Reviewing files that changed from the base of the PR and between 29b48c4 and 33b19c6.

📒 Files selected for processing (2)
  • CLAUDE.md
  • docs/lessons-learned.md
✅ Files skipped from review due to trivial changes (1)
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Extracted the long "Lessons Learned" notes from CLAUDE.md into docs/lessons-learned.md; CLAUDE.md now contains a single pointer directing readers to search the new document by topic.

Changes

Documentation Organization

Layer / File(s) Summary
Lessons Learned document creation
docs/lessons-learned.md, CLAUDE.md
Adds docs/lessons-learned.md with the migrated bullet-point engineering lessons and updates CLAUDE.md to point readers to the new file for historical notes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through pages, packed and neat,
Moved the lessons where they can meet,
A tidy note, a single guide,
History kept and easy to find. 🥕📚

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly describes the main change: moving the Lessons Learned section from CLAUDE.md to a new docs/ file, which aligns with the primary objective of the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/lessons-learned.md`:
- Line 20: Replace the product/platform naming typos in docs/lessons-learned.md:
change the string "GH Actions" to "GitHub Actions" (occurs where
workflow/publish.yml is mentioned) and change "SqlLite" to the correct "SQLite"
(around the later mention on the file), ensuring both exact-word replacements
preserve surrounding punctuation and casing.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 798e4fb6-7ee6-44dd-8f63-5163aba25752

📥 Commits

Reviewing files that changed from the base of the PR and between 33aa6e9 and 29b48c4.

📒 Files selected for processing (2)
  • CLAUDE.md
  • docs/lessons-learned.md

Comment thread docs/lessons-learned.md Outdated
Rebased on master post-PR-152 (SQLite outbox revert) and applied
CodeRabbit review fixes: GH Actions → GitHub Actions, SqlLite → SQLite.
@blehnen blehnen force-pushed the trim-claude-md-lessons branch from 29b48c4 to 33b19c6 Compare May 27, 2026 16:08
@codecov
Copy link
Copy Markdown

codecov Bot commented May 27, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.80%. Comparing base (cbd78ef) to head (33b19c6).
⚠️ Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #153      +/-   ##
==========================================
- Coverage   89.83%   89.80%   -0.04%     
==========================================
  Files        1002     1002              
  Lines       29703    29703              
  Branches     2405     2405              
==========================================
- Hits        26684    26674      -10     
- Misses       2360     2367       +7     
- Partials      659      662       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@blehnen blehnen merged commit 585b50c into master May 27, 2026
5 checks passed
@blehnen blehnen deleted the trim-claude-md-lessons branch May 27, 2026 19:44
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