docs: compress AGENTS.md to reduce AI agent token footprint#335
docs: compress AGENTS.md to reduce AI agent token footprint#335piotrzajac merged 1 commit intomasterfrom
Conversation
Remove three Mermaid diagrams, condense the repository layout tree, and strip low-value prose (Local Developer Setup walkthrough, CI/CD flowchart, Dependency Management Other row). Add two rules missing from the Test Conventions: data-source attributes must appear above [Theory], and [Collection] must use the subject class name. Closes TASK-18 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
📝 WalkthroughWalkthroughConfiguration and documentation updates across the repository, including adding an "agent" label to backlog configuration, creating a new task for documentation compression, updating .NET framework references from net8.0 to net10.0 across multiple files, and streamlining AGENTS.md by removing Mermaid diagrams and simplifying explanations. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 3 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Line 48: The tests and docs currently reference net10.0; change the primary
target from net10.0 to net8.0 by updating the TargetFramework/TargetFrameworks
entries in the four test project files
(Objectivity.AutoFixture.XUnit2.Core.Tests.csproj,
Objectivity.AutoFixture.XUnit2.AutoMoq.Tests.csproj,
Objectivity.AutoFixture.XUnit2.AutoNSubstitute.Tests.csproj,
Objectivity.AutoFixture.XUnit2.AutoFakeItEasy.Tests.csproj) to include net8.0
(and keep net472 and net48 if multi-targeting via TargetFrameworks), and update
the test command in CONTRIBUTING.md (the dotnet test line) to use --framework
net8.0 instead of net10.0.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: e48d4d83-47a2-4f97-b3ea-8de939af70dc
📒 Files selected for processing (5)
.backlog/config.yml.backlog/tasks/task-18 - Compress-AGENTS.md.md.github/ISSUE_TEMPLATE/1-bug-report.ymlAGENTS.mdCONTRIBUTING.md
Summary
Otherrow[Theory], and[Collection]must use the subject class nameResult: 544 → 410 lines (−25%), reducing token cost for every AI agent context load.
Test plan
Closes TASK-18
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
Chores