suspensive
suspensive copied to clipboard
docs: Add comprehensive AI assistant documentation
Overview
AI assistants (GitHub Copilot, Cursor, etc.) need structured context to understand Suspensive's monorepo architecture, conventions, and patterns. This adds 1,270 lines of documentation across strategic locations to provide that context.
Changes
-
.cursorrules(251 lines) - Primary AI assistant guide covering project architecture, monorepo structure, development workflow, code patterns, testing strategy, and common pitfalls -
.github/copilot/instructions.md(196 lines) - GitHub Copilot-specific instructions with quick context, code patterns, and package-specific notes -
AI_DEVELOPMENT_GUIDE.md(268 lines) - Quick reference with package table, core APIs, directory structure, and workflow commands -
Package-level
.ai-context.mdfiles (555 lines) - Context forpackages/react,packages/react-query,packages/react-dom, anddocs/suspensive.orgcovering package purpose, key APIs, and common patterns -
README.md- Added AI documentation section with links to resources
Coverage
- Monorepo structure and inter-package dependencies
- SSR considerations for all components
- TypeScript patterns and type safety requirements
- Testing conventions (
.spec.tsxvs.test-d.tsx) - Build system (tsdown, turborepo, pnpm workspaces)
- Version detection for @tanstack/react-query (v4/v5)
PR Checklist
- [x] I did below actions if need
- I read the Contributing Guide
- I added documents and tests.
[!WARNING]
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
dummyjson.com
- Triggering command:
/usr/local/bin/node /home/REDACTED/work/suspensive/suspensive/node_modules/.pnpm/[email protected]_@babel+[email protected][email protected][email protected][email protected]/node_modules/next/dist/compiled/jest-worker/processChild.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
- Configure Actions setup steps to set up my environment, which run before the firewall is enabled
- Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)
Original prompt
This section details on the original issue you should resolve
<issue_title>[Feature]: AI should know suspensive well</issue_title> <issue_description>### Package Scope
etc
Description
I have no idea, you can suggest? We need to update our doc or everything AI friendly
Possible Solution
No response
etc.
No response</issue_description>
Comments on the Issue (you are @copilot in this section)
- Fixes toss/suspensive#1820
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.
⚠️ No Changeset found
Latest commit: feef5153c8f3f693d63221303b2f139d2b4c9d8c
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
The latest updates on your projects. Learn more about Vercel for GitHub.
| Project | Deployment | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| suspensive-next-streaming-react-query | Preview | Comment | Nov 12, 2025 6:52am | |
| v2.suspensive.org | Preview | Comment | Nov 12, 2025 6:52am | |
| v3.suspensive.org | Nov 12, 2025 6:52am | |||
| visualization.suspensive.org | Preview | Comment | Nov 12, 2025 6:52am |