Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 12, 2025

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.md files (555 lines) - Context for packages/react, packages/react-query, packages/react-dom, and docs/suspensive.org covering 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.tsx vs .test-d.tsx)
  • Build system (tsdown, turborepo, pnpm workspaces)
  • Version detection for @tanstack/react-query (v4/v5)

PR Checklist

  • I did below actions if need
  1. I read the Contributing Guide
  2. 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:

If you need me to access, download, or install something from one of these locations, you can either:

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)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@changeset-bot
Copy link

changeset-bot bot commented Nov 12, 2025

⚠️ No Changeset found

Latest commit: feef515

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

@vercel
Copy link

vercel bot commented Nov 12, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
suspensive-next-streaming-react-query Ready Ready Preview Comment Nov 12, 2025 6:52am
v2.suspensive.org Ready Ready Preview Comment Nov 12, 2025 6:52am
v3.suspensive.org Canceled Canceled Nov 12, 2025 6:52am
visualization.suspensive.org Ready Ready Preview Comment Nov 12, 2025 6:52am

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.

[Feature]: AI should know suspensive well

2 participants