docs: Add comprehensive AI assistant documentation #1821
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.
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 notesAI_DEVELOPMENT_GUIDE.md(268 lines) - Quick reference with package table, core APIs, directory structure, and workflow commandsPackage-level
.ai-context.mdfiles (555 lines) - Context forpackages/react,packages/react-query,packages/react-dom, anddocs/suspensive.orgcovering package purpose, key APIs, and common patternsREADME.md- Added AI documentation section with links to resourcesCoverage
.spec.tsxvs.test-d.tsx)PR Checklist
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/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:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.