Skip to content

docs: add agentic docs workflow guidance (AGENTS.md) - #2429

Draft
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/agentic-docs-workflow
Draft

docs: add agentic docs workflow guidance (AGENTS.md)#2429
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/agentic-docs-workflow

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Add root AGENTS.md so coding agents detect user-visible code changes and route documentation work in parallel (or inline when subagents are unavailable).
  • Add docs/AGENTS.md with a compact NVIDIA Writing Style Guide and NRL-specific doc patterns for MkDocs extraction docs.
  • Add docs/DORI_SETUP.md for explicit DORI install/config only (no auto-install; no MCP/host changes in this PR).

Notes

  • Implements Eric’s docs-agent-setup pilot surfaces for NeMo-Retriever ahead of 26.07 RC QA.
  • Does not add CI/hooks, product skills under .agents/, or CLAUDE.md changes. Existing tracked .agents file (.claude) is left unchanged.

Test plan

  • Review the three new files for accuracy against NRL docs layout (docs/docs/extraction/, MkDocs).
  • Confirm PR diff is only AGENTS.md, docs/AGENTS.md, docs/DORI_SETUP.md.
  • Optional: in a Cursor session on this branch, confirm agents load root/docs AGENTS guidance.
  • Do not run DORI install or host MCP setup as part of verifying this PR.

Configure root and docs AGENTS guidance so coding agents route user-visible code changes into documentation work before RC QA.
@kheiss-uwzoo kheiss-uwzoo self-assigned this Aug 4, 2026
@kheiss-uwzoo kheiss-uwzoo added 26.08 doc Improvements or additions to documentation labels Aug 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

26.08 doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant