Skip to content

feat: add grove-user-guide AI agent skill for authoring user docs#589

Merged
shmuel-runai merged 2 commits into
ai-dynamo:mainfrom
shmuel-runai:grove/skill-user-guide-pr
May 10, 2026
Merged

feat: add grove-user-guide AI agent skill for authoring user docs#589
shmuel-runai merged 2 commits into
ai-dynamo:mainfrom
shmuel-runai:grove/skill-user-guide-pr

Conversation

@shmuel-runai

Copy link
Copy Markdown
Contributor

/kind feature
Ref #588

Summary

  • Adds a /grove-user-guide skill at .agents/skills/grove-user-guide/SKILL.md for AI coding agents (Cursor, Claude Code, Copilot, etc.)
  • Invoking /grove-user-guide starts an interactive dialogue that guides the user through writing a Grove user guide section by section
  • Includes style-reference.md with Grove-specific formatting rules, terminology conventions, and YAML example guidelines aligned with the Kubernetes documentation style guide
  • The skill writes the guide file incrementally as each section is confirmed, and supports resuming work on an existing guide

How it works

  1. User runs /grove-user-guide in their AI coding agent
  2. The agent searches for an existing guide in docs/user-guide/ matching the topic
  3. If found, offers to update it section by section; if not, starts a new guide
  4. Walks through each section interactively — drafts content, waits for confirmation, writes to file immediately
  5. Enforces consistent terminology (PascalCase API objects, code-style annotations, realistic YAML examples)

Agent compatibility

Skills live in .agents/skills/ — a neutral location not tied to any specific AI tool. Claude Code resolves them via the .claude/skills.agents/skills directory symlink. Other agents can be wired up similarly.

Similar to the existing /grove-grep skill (#522) which standardized GREP authoring.

Made with Cursor

Adds an interactive agent skill that guides AI coding agents through
writing or updating Grove user guides in docs/user-guide/, ensuring
consistent structure, terminology, and style.

Ref ai-dynamo#588

Co-authored-by: Cursor <cursoragent@cursor.com>
@copy-pr-bot

copy-pr-bot Bot commented May 7, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@athreesh athreesh left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

looks good overall. this mirrors the /grove-grep flow nicely, and the section-by-section confirmation/write loop is the right guardrail for docs authored with agents.

left one non-blocking note on tightening the numbered tutorial-series branch. the standalone guide path is clear.

Comment thread .agents/skills/grove-user-guide/SKILL.md
@shmuel-runai shmuel-runai merged commit 3f70131 into ai-dynamo:main May 10, 2026
14 checks passed
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.

3 participants