Skip to content

docs: compress AGENTS.md to reduce AI agent token footprint#335

Merged
piotrzajac merged 1 commit intomasterfrom
docs/compress-agents-md
Apr 22, 2026
Merged

docs: compress AGENTS.md to reduce AI agent token footprint#335
piotrzajac merged 1 commit intomasterfrom
docs/compress-agents-md

Conversation

@piotrzajac
Copy link
Copy Markdown
Collaborator

@piotrzajac piotrzajac commented Apr 22, 2026

Summary

  • Remove three Mermaid diagrams (classDiagram, sequenceDiagram, CI/CD flowchart) and replace with concise prose
  • Compress the repository layout ASCII tree from ~50 to 14 lines
  • Remove the Local Developer Setup walkthrough (commands are already in the Build section) and the Dependency Management Other row
  • Add two test convention rules that were missing: data-source attributes must appear above [Theory], and [Collection] must use the subject class name

Result: 544 → 410 lines (−25%), reducing token cost for every AI agent context load.

Test plan

  • Verify AGENTS.md renders correctly in GitHub
  • Confirm AI Agent Working Rules section is preserved verbatim
  • Confirm both new test convention rules are present

Closes TASK-18

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Updated .NET framework examples from version 8.0 to 10.0 across documentation
    • Streamlined repository overview with condensed architecture guidance
    • Simplified test conventions documentation with explicit attribute ordering requirements
    • Removed visual diagrams in favor of prose-based explanations
  • Chores

    • Added "agent" label to backlog configuration

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>
@piotrzajac piotrzajac self-assigned this Apr 22, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

📝 Walkthrough

Walkthrough

Configuration 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

Cohort / File(s) Summary
Configuration & Backlog
.backlog/config.yml, .backlog/tasks/task-18 - Compress-AGENTS.md.md
Added "agent" label to backlog configuration; created new task document defining acceptance criteria for AGENTS.md compression including diagram removal, prose replacement, and convention documentation.
Issue Templates
.github/ISSUE_TEMPLATE/1-bug-report.yml
Updated bug report template's "Target framework" placeholder from net8.0 to net10.0.
Repository Documentation
AGENTS.md, CONTRIBUTING.md
Removed Mermaid diagrams and condensed architectural explanations in AGENTS.md; updated test framework references from net8.0 to net10.0; added new test convention requiring data source attributes above [Theory]; simplified repository layout and CI/CD sections; updated framework version in test command in CONTRIBUTING.md.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • PR #320: Modifies backlog configuration and AGENTS.md with concurrent framework version upgrades and documentation restructuring.
  • PR #300: Updates AGENTS.md documentation and introduces test convention changes that are directly affected by this PR's modifications.
  • PR #301: Modifies .backlog/config.yml and AGENTS.md documentation alongside this PR's changes.

Suggested labels

enhancement

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning PR description lacks required sections: missing issue link in 'Closes' (references TASK-18 instead of GitHub issue), missing PR label guidance, and incomplete checklist items. Link a specific GitHub issue number (e.g., 'Closes #XXX'), clarify which label was added to the PR, and verify or complete all checklist items before merging.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: compressing AGENTS.md documentation to reduce token footprint for AI agents.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/compress-agents-md

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 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

📥 Commits

Reviewing files that changed from the base of the PR and between fc951ee and a977bec.

📒 Files selected for processing (5)
  • .backlog/config.yml
  • .backlog/tasks/task-18 - Compress-AGENTS.md.md
  • .github/ISSUE_TEMPLATE/1-bug-report.yml
  • AGENTS.md
  • CONTRIBUTING.md

Comment thread CONTRIBUTING.md
@piotrzajac piotrzajac merged commit 8d0fe72 into master Apr 22, 2026
3 checks passed
@piotrzajac piotrzajac deleted the docs/compress-agents-md branch April 22, 2026 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant