fix: add missing AGENTS.md in template#2106
Conversation
|
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughA new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds a missing AGENTS.md file to the template-common directory, providing guidance for AI coding assistants working with Rspeedy projects. The file helps AI agents understand the project structure, available commands, and relevant documentation resources.
Changes:
- Added
AGENTS.mdfile with AI agent instructions for Rspeedy/Lynx projects
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Zhiyuan Hong <28915578+hzy@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In @packages/rspeedy/create-rspeedy/template-common/AGENTS.md:
- Line 10: Replace the incorrect article "a" with "an" in the sentence "While
dealing with a Lynx task, an agent **MUST** read this doc because it is a
entrypoint of all available docs about Lynx." so it reads "...because it is an
entrypoint of all available docs about Lynx." Ensure the updated sentence
preserves emphasis and punctuation exactly as in the original.
- Line 9: Update the Lynx documentation link in AGENTS.md by replacing the
incorrect "/next/llms.txt" path with the canonical root path
"https://lynxjs.org/llms.txt" for the Lynx entry (the line that reads like
"Lynx: [llms.txt](https://lynxjs.org/next/llms.txt), **REQUIRED**").
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/rspeedy/create-rspeedy/template-common/AGENTS.md
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-27T08:10:09.932Z
Learnt from: colinaaa
Repo: lynx-family/lynx-stack PR: 1612
File: packages/rspeedy/create-rspeedy/template-react-vitest-rltl-ts/src/tsconfig.json:3-13
Timestamp: 2025-08-27T08:10:09.932Z
Learning: In the lynx-family/lynx-stack repository, Rspeedy templates use `lynx-js/rspeedy/client` types via `rspeedy-env.d.ts` instead of `vite/client` types. Rspeedy provides its own client-side environment type definitions and doesn't require direct Vite type references.
Applied to files:
packages/rspeedy/create-rspeedy/template-common/AGENTS.md
📚 Learning: 2025-12-26T05:10:01.608Z
Learnt from: CR
Repo: lynx-family/lynx-stack PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-26T05:10:01.608Z
Learning: Applies to packages/rspeedy/plugin-*/**/*.{ts,tsx,js} : Configure build plugins using the plugin architecture in packages/rspeedy/plugin-*/
Applied to files:
packages/rspeedy/create-rspeedy/template-common/AGENTS.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Agent
🔇 Additional comments (3)
packages/rspeedy/create-rspeedy/template-common/AGENTS.md (3)
1-3: LGTM!The header and expertise statement clearly define the scope for AI agents working with this template.
12-20: LGTM!The commands section provides essential development workflow commands that are standard for Rspeedy projects.
22-26: No action needed — the documentation URLs are accessible and valid.Both the Rsbuild and Rspack documentation URLs return HTTP 200 status codes and are working correctly.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.
Checklist