Skip to content

docs: split agent guide into focused references - #64206

Open
fff-sissimo wants to merge 1 commit into
NousResearch:mainfrom
fff-sissimo:docs/split-agents-reference-20260714
Open

docs: split agent guide into focused references#64206
fff-sissimo wants to merge 1 commit into
NousResearch:mainfrom
fff-sissimo:docs/split-agents-reference-20260714

Conversation

@fff-sissimo

Copy link
Copy Markdown

Summary

  • keep the root AGENTS.md as a concise 129-line entry point
  • move detailed subsystem guidance into focused files under references/agent-guide/
  • add explicit read-when routing and a 250-line policy for core instruction documents

Validation

  • content preservation check against the previous AGENTS.md: PASS
  • relative file links and anchors: PASS
  • all core instruction and new reference documents are at most 250 lines
  • git diff --check: PASS
  • credential-shaped string scan: no findings

Test plan

  • Not run (documentation-only change).

@alt-glitch alt-glitch added type/docs Documentation improvements comp/agent Core agent runtime: loop, agent_init, prompt builder, context-compression, responses endpoint P3 Low — cosmetic, nice to have labels Jul 14, 2026

@teknium1 teknium1 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the focused routing map and the effort to preserve the existing guide.

Problems

  • The split omits the current test-placement policy. Current AGENTS.md:1309-1319 requires assertions about package.json, lockfiles, and JS/TS source to live in the Vitest suite because the CI classifier can skip Python tests on JS-only changes. That policy was added by f8abc521f after this PR's base. The proposed references/agent-guide/testing.md moves from the wrapper explanation at lines 21-33 directly to change-detector guidance at line 36, so the rule would be lost.

Suggested changes

  • Transplant AGENTS.md:1309-1319 into references/agent-guide/testing.md, and validate the moved content against current main rather than only the PR base.

Automated hermes-sweeper review.

| Locale | Whatever is set | C.UTF-8 |


### Don't write change-detector tests

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please add the current AGENTS.md:1309-1319 “Where to place what tests” policy before this heading. It was added in f8abc521f after this branch's base and requires JS/package-artifact assertions to live in Vitest; otherwise this split drops an active CI-safety rule.

@teknium1 teknium1 added the sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users label Jul 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

comp/agent Core agent runtime: loop, agent_init, prompt builder, context-compression, responses endpoint P3 Low — cosmetic, nice to have sweeper:blast-contained Sweeper blast radius: contained — one narrow path / opt-in / few users type/docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants