Skip to content

docs: trim always-loaded agent guides - #688

Draft
dmihalcik-virtru wants to merge 1 commit into
mainfrom
docs-trim-agent-guides
Draft

dmihalcik-virtru wants to merge 1 commit into
mainfrom
docs-trim-agent-guides

Conversation

@dmihalcik-virtru

Copy link
Copy Markdown
Member

Root AGENTS.md (which CLAUDE.md symlinks to) loads into every agent session. This trims it from ~10.5k to ~5.5k chars.

Cut: things a session can work out by reading the repo

  • The repository layout table. The two gotchas stay as bullets: platform/ is installed rather than committed, and the dist/ wrappers come from otdf-sdk-mgr install.
  • The "Test Runner" blurb and the standard pytest file.py / file.py::test examples.
  • Generic RSA/EC wrapping descriptions. The KAO type names and the ec_tdf_enabled requirement stay.
  • "Debugging Workflow". Its curls repeat Quick Reference, and its manual repro repeats xtest/AGENTS.md.
  • "When Modifying Test Code" and "Test File Organization". Both repeat the xtest/AGENTS.md layout.

Moved: xtest-only material, so it only loads when needed

  • The XT_FORCE_SUPPORTS walkthrough moves to xtest/AGENTS.md. The root keeps a one-line warning, because the failure is silent: version gates skip the cell and the run goes green.
  • The XT_* variable bullets are dropped from the root. They were already in xtest's env table, which now also notes the force-platform-supports CI input.
  • "Common Test Failures and Debugging" becomes .claude/skills/xtest-troubleshooting/SKILL.md, copied word for word. The root keeps a pointer so agents that don't read skills can still find it.

Nested guides

  • xtest/AGENTS.md: drops the layout rows for test_*.py, conftest.py, fixtures/ and tdfs.py.
  • otdf-local/AGENTS.md: drops log commands that were listed twice and two generic "Extending" bullets.

Docs only, no code changes.

Cut content a session can rederive from the repo (layout tables, standard
pytest invocations, generic debugging steps, the test-file tour) from the
root AGENTS.md, which CLAUDE.md symlinks to and every session loads.

Move xtest-only material to where it loads lazily: the XT_FORCE_SUPPORTS
walkthrough and XT_* variables into xtest/AGENTS.md, and the known-failure
recipes into a .claude/skills/xtest-troubleshooting skill. The root keeps a
one-line warning that version gates make an unreleased fix skip silently,
plus a pointer to the recipes for agents that don't read skills.

Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
@coderabbitai

coderabbitai Bot commented Oct 30, 2026

Copy link
Copy Markdown

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@sonarqubecloud

Copy link
Copy Markdown

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