Skip to content

Comments

docs: introduces doc files for LLM agents#438

Open
spencercjh wants to merge 1 commit intochaos-mesh:masterfrom
spencercjh:feat/agent-md
Open

docs: introduces doc files for LLM agents#438
spencercjh wants to merge 1 commit intochaos-mesh:masterfrom
spencercjh:feat/agent-md

Conversation

@spencercjh
Copy link
Contributor

@spencercjh spencercjh commented Dec 19, 2025

Parts of this PR were drafted with assistance from Warp (with claude-4.5-sonnet) and fully reviewed and edited by me. I take full responsibility for all changes.

Copilot AI review requested due to automatic review settings December 19, 2025 06:17
@netlify
Copy link

netlify bot commented Dec 19, 2025

Deploy Preview for chaos-mesh-website-preview ready!

Name Link
🔨 Latest commit 733a831
🔍 Latest deploy log https://app.netlify.com/projects/chaos-mesh-website-preview/deploys/6944ee4d24cff300086d8efd
😎 Deploy Preview https://deploy-preview-438--chaos-mesh-website-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: spencercjh <spencercjh@gmail.com>
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request introduces documentation files specifically designed to provide context and guidance to LLM agents working with the Chaos Mesh documentation website codebase. The documentation covers project architecture, development workflows, and important technical details.

Key changes:

  • Adds comprehensive AGENTS.md file documenting the Docusaurus 3-based website structure, development commands, versioning system, and i18n architecture
  • Creates pointer files (WARP.md, CLAUDE.md, AGENT.md) that reference AGENTS.md for different LLM agent tools

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
AGENTS.md Main documentation file providing comprehensive guidance on project structure, development workflows, configuration, and best practices for LLM agents
WARP.md Pointer file containing reference to AGENTS.md for Warp terminal AI agent
CLAUDE.md Pointer file containing reference to AGENTS.md for Claude AI agent
AGENT.md Pointer file containing reference to AGENTS.md for generic AI agents

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


### Node Version

Requires Node.js **>=22.0.0** (specified in `package.json` engines field). Check `.nvmrc` for exact version.
Copy link

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

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

The reference to ".nvmrc for exact version" is misleading. The .nvmrc file contains "lts/*" which specifies the latest LTS version, not an exact version number. This statement should be corrected to indicate that .nvmrc specifies the LTS version rather than an exact version.

Suggested change
Requires Node.js **>=22.0.0** (specified in `package.json` engines field). Check `.nvmrc` for exact version.
Requires Node.js **>=22.0.0** (specified in `package.json` engines field). `.nvmrc` specifies the latest LTS Node.js version via `lts/*`.

Copilot uses AI. Check for mistakes.
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