mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Markus Ecker
036d5412cc
- Move original CopilotKit/CopilotKit directory to src/v1.x - Introduce new v2 interfaces in src/v2.x - Align CI paths and preview environments to new layout Signed-off-by: Tyler Slaton <tyler@copilotkit.ai> Co-authored-by: Ran Shemtov <ran@copilotkit.ai> Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com> Co-authored-by: Mike Ryan <mike.ryan52@gmail.com>
67 lines
2.8 KiB
Plaintext
67 lines
2.8 KiB
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: false
|
|
---
|
|
# CopilotKit Development Workflow
|
|
|
|
## Workspace Setup
|
|
CopilotKit uses a monorepo structure with:
|
|
- **[src/v1.x/package.json](mdc:src/v1.x/package.json)** - Main workspace configuration
|
|
- **[src/v1.x/packages/](mdc:src/v1.x/packages)** - Core library packages
|
|
- **[examples/](mdc:examples)** - Example applications
|
|
|
|
## Development Scripts
|
|
Located in [src/v1.x/scripts/](mdc:src/v1.x/scripts):
|
|
|
|
### Development Scripts
|
|
- **[develop/](mdc:src/v1.x/scripts/develop)** - Development environment setup
|
|
- **[qa/](mdc:src/v1.x/scripts/qa)** - Quality assurance and testing scripts
|
|
- **[release/](mdc:src/v1.x/scripts/release)** - Release automation scripts
|
|
|
|
### Documentation Scripts
|
|
- **[docs/](mdc:src/v1.x/scripts/docs)** - Documentation generation and management
|
|
|
|
## Package Management
|
|
- Uses pnpm workspaces for package management
|
|
- Local packages are linked automatically within the workspace
|
|
- Examples reference local packages via workspace protocol
|
|
|
|
## Testing
|
|
- **[e2e/](mdc:examples/e2e)** - End-to-end testing setup with Playwright
|
|
- **[playwright.config.ts](mdc:examples/e2e/playwright.config.ts)** - Playwright configuration
|
|
- Test results in [test-results/](mdc:examples/e2e/test-results)
|
|
|
|
## Documentation Site
|
|
- **[docs/](mdc:docs)** - Documentation website built with Next.js
|
|
- **[content/docs/](mdc:docs/content/docs)** - Markdown documentation files
|
|
- **[components/react/](mdc:docs/components/react)** - React component examples
|
|
- **[snippets/](mdc:docs/snippets)** - Code snippets for documentation
|
|
|
|
## Configuration Files
|
|
- **[CopilotKit.code-workspace](mdc:src/v1.x/CopilotKit.code-workspace)** - VS Code workspace settings
|
|
- **[utilities/](mdc:src/v1.x/utilities)** - Shared utilities:
|
|
- [eslint-config-custom/](mdc:src/v1.x/utilities/eslint-config-custom) - ESLint configuration
|
|
- [tailwind-config/](mdc:src/v1.x/utilities/tailwind-config) - Tailwind CSS configuration
|
|
- [tsconfig/](mdc:src/v1.x/utilities/tsconfig) - TypeScript configurations
|
|
|
|
## Infrastructure
|
|
- **[infra/](mdc:infra)** - AWS CDK infrastructure code
|
|
- **[helmfile/](mdc:examples/helmfile)** - Kubernetes deployment configuration
|
|
- **[Dockerfile.*](mdc:examples/Dockerfile.agent-js)** - Docker configurations for different components
|
|
|
|
## Component Registry
|
|
- **[registry/](mdc:registry)** - Component registry for reusable components
|
|
- **[registry/registry/](mdc:registry/registry)** - Registry content:
|
|
- [chat/](mdc:registry/registry/chat) - Chat components
|
|
- [quickstarts/](mdc:registry/registry/quickstarts) - Quick start templates
|
|
|
|
## Development Best Practices
|
|
1. Work within the monorepo structure
|
|
2. Use the provided scripts for common tasks
|
|
3. Test changes with relevant examples
|
|
4. Follow the established patterns in existing code
|
|
5. Update documentation when adding new features
|
|
|
|
|