docs: add agent prompt component and agent install instructions#1120
Merged
Conversation
Amp-Thread-ID: https://ampcode.com/threads/T-019d3e1c-5433-735f-a525-96ee6ffb303f Co-authored-by: Amp <amp@ampcode.com>
Deploying rstest with
|
| Latest commit: |
5bfad21
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2e78313a.rstest.pages.dev |
| Branch Preview URL: | https://docs-agent-prompt.rstest.pages.dev |
Rsdoctor Bundle Diff Analysis
Found 12 projects in monorepo, 0 projects with changes. 📊 Quick Summary
Generated by Rsdoctor GitHub Action |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 467892baa7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
fi3ework
force-pushed
the
docs/agent-prompt
branch
from
d6d2e57 to
c17e1a1
Compare
Co-authored-by: Amp <amp@ampcode.com> Amp-Thread-ID: https://ampcode.com/threads/T-019d3e1c-5433-735f-a525-96ee6ffb303f
fi3ework
force-pushed
the
docs/agent-prompt
branch
from
c17e1a1 to
aad2a1f
Compare
- Restructure as sequential agent steps with clear decision points - Split inventory into repo-wide (Step 0) and package-scoped (Step 2) - Replace inline setup details with links to canonical doc pages - Add guardrails for Jest/Vitest coexistence and test isolation - Add migration guide exit ramp in Step 0 - Fix monorepo deps/config/scripts ownership rules - Add zero-test validation path (--passWithNoTests) - Broaden script protection to all test-related scripts - Add Bun support and packageManager field fallback Amp-Thread-ID: https://ampcode.com/threads/T-019d4805-4494-7349-a62e-5ea8ecb5cbfe Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019d4805-4494-7349-a62e-5ea8ecb5cbfe Co-authored-by: Amp <amp@ampcode.com>
9aoy
approved these changes
Apr 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
(specifically adjusted the switching speed to 2s for recording the video.)
Untitled.mp4
Background
The Rstest documentation lacks a standardized way for AI coding agents (Claude Code, Cursor, Amp, Codex, opencode, etc.) to set up Rstest in a project. Users currently must manually guide their agents through installation steps.
Implementation
website/docs/en/shared/agent-install.mdx— a detection-first, 9-step setup guide that agents can follow (detects workspace scope, language, framework, test environment, then installs deps, creates config, updates scripts, writes tests, and validates)AgentPromptcomponent with rotating agent icons (10s interval, 200ms fade), copy-to-clipboard, and theme-aware header tintingMdOnlycomponent that renders content only in.mdoutput (viaimport.meta.env.SSG_MD)quick-start.mdxandai.mdx(both EN and ZH)en/guide/start/agent-install.mdxandzh/counterpart as thin wrappers importing from sharedUser Impact
Users can now copy a single prompt into any AI coding agent to automatically set up Rstest in their project with proper detection of their tech stack.
Checklist