docs: introduces doc files for LLM agents#438
docs: introduces doc files for LLM agents#438spencercjh wants to merge 1 commit intochaos-mesh:masterfrom
Conversation
✅ Deploy Preview for chaos-mesh-website-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: spencercjh <spencercjh@gmail.com>
c8e8d02 to
733a831
Compare
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
| 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/*`. |
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.