Skip to content

fix: add missing AGENTS.md in template#2106

Merged
colinaaa merged 2 commits intolynx-family:mainfrom
hzy:p/hzy/agents_md_in_template
Jan 12, 2026
Merged

fix: add missing AGENTS.md in template#2106
colinaaa merged 2 commits intolynx-family:mainfrom
hzy:p/hzy/agents_md_in_template

Conversation

@hzy
Copy link
Copy Markdown
Collaborator

@hzy hzy commented Jan 12, 2026

Summary by CodeRabbit

  • Documentation
    • Added agent guidelines covering required commands (dev, build, preview, inspect), recommended expertise areas, suggested preparatory reading, and references to related tooling documentation.

✏️ Tip: You can customize this high-level summary in your review settings.

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).
  • Changeset added, and when a BREAKING CHANGE occurs, it needs to be clearly marked (or not required).

Copilot AI review requested due to automatic review settings January 12, 2026 11:18
@hzy hzy requested review from colinaaa and upupming as code owners January 12, 2026 11:18
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Jan 12, 2026

⚠️ No Changeset found

Latest commit: 60ec7f2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 12, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A new AGENTS.md file was added to packages/rspeedy/create-rspeedy/template-common, specifying agent expertise (JavaScript, Rspeedy, Lynx), required commands (dev, build, preview, rspeedy inspect), and links to Rsbuild/Rspack and Lynx documentation.

Changes

Cohort / File(s) Summary
Agent documentation
packages/rspeedy/create-rspeedy/template-common/AGENTS.md
New file (+26 lines) introducing agent guidelines: expertise areas, prerequisite reading (Lynx docs), required commands (dev, build, preview, rspeedy inspect), and links to Rsbuild/Rspack docs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 I hopped in with a README bright,
I penned the steps for agents' flight,
JavaScript, Rspeedy, Lynx in tune,
Dev, build, preview — follow soon,
A tiny trail for coders' light. 🚀

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: adding a missing AGENTS.md file to the template. It is concise, specific, and clearly describes the primary change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 34ed17b and 60ec7f2.

📒 Files selected for processing (1)
  • packages/rspeedy/create-rspeedy/template-common/AGENTS.md

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

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 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.md file with AI agent instructions for Rspeedy/Lynx projects

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

Comment thread packages/rspeedy/create-rspeedy/template-common/AGENTS.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Zhiyuan Hong <28915578+hzy@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c2b51a and 34ed17b.

📒 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.

Comment thread packages/rspeedy/create-rspeedy/template-common/AGENTS.md
Comment thread packages/rspeedy/create-rspeedy/template-common/AGENTS.md Outdated
@colinaaa colinaaa merged commit 9e774c8 into lynx-family:main Jan 12, 2026
3 of 4 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