Skip to content

docs: Add comprehensive AGENTS.md documentation page - #4804

Merged
alexkgold merged 3 commits into
mainfrom
docs/agents-md-documentation
Jan 6, 2026
Merged

docs: Add comprehensive AGENTS.md documentation page#4804
alexkgold merged 3 commits into
mainfrom
docs/agents-md-documentation

Conversation

@kilo-code-bot

@kilo-code-bot kilo-code-bot Bot commented Jan 5, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR adds a comprehensive standalone documentation page for AGENTS.md files to the Agent Behavior section of the documentation.

Changes

  • New Documentation Page: Created covering:

    • What AGENTS.md files are and their purpose
    • Supported syntax and configuration options
    • File location and naming conventions (project root and subdirectories)
    • Practical examples for common use cases:
      • React project standards
      • Backend API standards
      • Security-focused projects
      • Documentation standards
      • Testing requirements
    • Best practices for writing effective agent instructions
    • How multiple AGENTS.md files interact (hierarchy and precedence)
    • Integration with Kilo Code's other configuration systems
    • Troubleshooting guide
    • Migration information from other tools
  • Navigation Update: Added the new page to in the Agent Behavior section, positioned after "Prompt Engineering" and before "Custom Modes"

  • Changeset: Added changeset for documentation addition

Key Features

  • Written for all users, not just those migrating from other tools
  • Comprehensive coverage of AGENTS.md as a first-class feature
  • Clear, practical examples demonstrating real-world usage
  • Explains how AGENTS.md works alongside Custom Rules, Custom Instructions, and Custom Modes
  • Includes hierarchy and precedence rules for multiple AGENTS.md files
  • Properly integrated into documentation site navigation

Testing

  • Validated Markdown syntax
  • Verified sidebar configuration
  • Confirmed proper placement in Agent Behavior section

Related Documentation

- Created new documentation page for AGENTS.md files in Agent Behavior section
- Covers what AGENTS.md is, syntax, file location, practical examples, and best practices
- Explains how AGENTS.md works in Kilo Code and interacts with other configuration systems
- Includes troubleshooting, migration guides, and advanced topics
- Added page to sidebars.ts navigation under Agent Behavior section
- Added changeset for documentation addition
@changeset-bot

changeset-bot Bot commented Jan 5, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 80b18e5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
kilo-code Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@kilo-code-bot

kilo-code-bot Bot commented Jan 5, 2026

Copy link
Copy Markdown
Contributor Author

✅ No Issues Found

3 files reviewed | Confidence: 95% | Recommendation: Merge

Review Details

Files:

  • .changeset/agents-md-documentation.md (changeset)
  • apps/kilocode-docs/docs/agent-behavior/agents-md.md (new documentation)
  • apps/kilocode-docs/sidebars.ts (navigation update)

Checked: Security, bugs, performance, error handling, documentation quality

Findings:

  • ✅ Changeset properly formatted with correct package name and patch version
  • ✅ Documentation is comprehensive, well-structured, and follows existing patterns
  • ✅ Cross-references to related docs (custom-rules, custom-modes, migrating-from-cursor-windsurf) are correct
  • ✅ Sidebar placement is logical (after "Prompt Engineering", before "Custom Modes")
  • ✅ Markdown syntax is valid
  • ✅ External links reference legitimate resources (agents.md, GitHub repos)
  • ✅ Content is consistent with existing documentation conventions

Removed multiple practical examples and guidelines related to React, backend API, security, documentation, testing, and project standards from agents-md.md.
@alexkgold
alexkgold requested a review from olearycrew January 6, 2026 15:14
@alexkgold
alexkgold enabled auto-merge January 6, 2026 15:19

## What is AGENTS.md?

AGENTS.md is an open standard for configuring AI agent behavior in software projects. It's a simple Markdown file placed at the root of your project that contains instructions for AI coding assistants. The standard is supported by multiple AI coding tools, including Kilo Code, Cursor, and Windsurf.

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.

Suggested change
AGENTS.md is an open standard for configuring AI agent behavior in software projects. It's a simple Markdown file placed at the root of your project that contains instructions for AI coding assistants. The standard is supported by multiple AI coding tools, including Kilo Code, Cursor, and Windsurf.
AGENTS.md is an [open standard](https://agents.md/) for configuring AI agent behavior in software projects. It's a simple Markdown file placed at the root of your project that contains instructions for AI coding assistants. The standard is supported by multiple AI coding tools, including Kilo Code, Cursor, and Windsurf.

@alexkgold
alexkgold merged commit c043220 into main Jan 6, 2026
12 checks passed
@alexkgold
alexkgold deleted the docs/agents-md-documentation branch January 6, 2026 17:00
slamj1 pushed a commit to slamj1/kilocode that referenced this pull request May 16, 2026
…tation

docs: Add comprehensive AGENTS.md documentation page
jliounis pushed a commit to jliounis/kilocode that referenced this pull request May 18, 2026
…tation

docs: Add comprehensive AGENTS.md documentation page
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.

2 participants