Skip to content

Commit 397da76

Browse files
committed
docs: Add comprehensive project documentation
- Add README, getting started, philosophy, and supported tools guides - Update CI badge URL in mcp-server README close #39
1 parent 333134a commit 397da76

5 files changed

Lines changed: 659 additions & 1 deletion

File tree

README.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Codingbuddy
2+
3+
[![CI](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml/badge.svg)](https://github.com/Codingbuddydev/codingbuddy/actions/workflows/dev.yml)
4+
[![npm version](https://img.shields.io/npm/v/codingbuddy.svg)](https://www.npmjs.com/package/codingbuddy)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
7+
**One source of truth for AI coding rules across all AI assistants.**
8+
9+
Codingbuddy provides a unified rules system that works with Cursor, Claude Code, GitHub Copilot, and more—so your entire team follows the same coding standards, regardless of which AI tool they use.
10+
11+
## Why Codingbuddy?
12+
13+
- **Consistency**: All AI tools follow identical coding standards
14+
- **Single Source of Truth**: Update rules once, all tools benefit
15+
- **No Vendor Lock-in**: AI-agnostic rules work with any assistant
16+
- **Structured Workflow**: PLAN → ACT → EVAL development cycle
17+
18+
## Quick Start
19+
20+
```bash
21+
# Initialize your project (analyzes codebase and creates config)
22+
npx codingbuddy init
23+
24+
# Add to your AI tool (example: Claude Desktop)
25+
# See docs/supported-tools.md for other AI tools
26+
```
27+
28+
Add to Claude Desktop config (`~/Library/Application Support/Claude/claude_desktop_config.json`):
29+
30+
```json
31+
{
32+
"mcpServers": {
33+
"codingbuddy": {
34+
"command": "npx",
35+
"args": ["codingbuddy-mcp"]
36+
}
37+
}
38+
}
39+
```
40+
41+
[Full Getting Started Guide →](docs/getting-started.md)
42+
43+
## Supported AI Tools
44+
45+
| Tool | Status |
46+
|------|--------|
47+
| Claude Code | ✅ Full MCP support |
48+
| Cursor | ✅ Supported |
49+
| GitHub Copilot | ✅ Supported |
50+
| Antigravity | ✅ Supported |
51+
| Amazon Q | ✅ Supported |
52+
| Kiro | ✅ Supported |
53+
54+
[Setup Guides →](docs/supported-tools.md)
55+
56+
## Documentation
57+
58+
| Document | Description |
59+
|----------|-------------|
60+
| [Getting Started](docs/getting-started.md) | Installation and quick setup |
61+
| [Philosophy](docs/philosophy.md) | Vision and design principles |
62+
| [Supported Tools](docs/supported-tools.md) | AI tool integration guides |
63+
| [Configuration](docs/config-schema.md) | Config file options |
64+
| [API Reference](docs/api.md) | MCP server capabilities |
65+
| [Development](docs/development.md) | Contributing and local setup |
66+
67+
## How It Works
68+
69+
```
70+
.ai-rules/ ← Shared rules (single source of truth)
71+
├── rules/ ← Core rules (workflow, quality)
72+
├── agents/ ← Specialist expertise (security, performance, etc.)
73+
└── adapters/ ← Tool-specific integration guides
74+
75+
.cursor/ ← Cursor references .ai-rules/
76+
.claude/ ← Claude Code references .ai-rules/
77+
.codex/ ← GitHub Copilot references .ai-rules/
78+
...
79+
```
80+
81+
All AI tool configurations reference the same `.ai-rules/` directory. Change the rules once, and every tool follows the updated standards.
82+
83+
## Contributing
84+
85+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
86+
87+
## License
88+
89+
MIT © [Codingbuddy](https://github.com/Codingbuddydev)

docs/getting-started.md

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
# Getting Started
2+
3+
Get up and running with Codingbuddy in minutes.
4+
5+
## Prerequisites
6+
7+
- **Node.js**: v18 or higher
8+
- **AI Tool**: Any supported AI coding assistant ([see full list](./supported-tools.md))
9+
10+
## Quick Start
11+
12+
### Step 1: Initialize Your Project
13+
14+
```bash
15+
# Set your Anthropic API key (required for project analysis)
16+
export ANTHROPIC_API_KEY=sk-ant-...
17+
18+
# Initialize Codingbuddy in your project
19+
npx codingbuddy init
20+
```
21+
22+
This command analyzes your project and creates a `codingbuddy.config.js` file with:
23+
24+
- Detected tech stack (languages, frameworks, tools)
25+
- Architecture patterns
26+
- Coding conventions
27+
- Testing strategy
28+
29+
### Step 2: Configure Your AI Tool
30+
31+
Add Codingbuddy to your AI assistant. Here's an example for Claude Desktop:
32+
33+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
34+
35+
```json
36+
{
37+
"mcpServers": {
38+
"codingbuddy": {
39+
"command": "npx",
40+
"args": ["codingbuddy-mcp"]
41+
}
42+
}
43+
}
44+
```
45+
46+
For other AI tools, see [Supported Tools](./supported-tools.md).
47+
48+
### Step 3: Start Coding
49+
50+
Your AI assistant now has access to:
51+
52+
- **Project context**: Tech stack, architecture, conventions
53+
- **Workflow modes**: PLAN → ACT → EVAL
54+
- **Specialist agents**: Security, performance, accessibility experts
55+
56+
Try it:
57+
58+
```
59+
You: PLAN Create a user authentication feature
60+
61+
AI: # Mode: PLAN
62+
I'll design an authentication feature following your project's patterns...
63+
```
64+
65+
## Configuration
66+
67+
### Generated Config File
68+
69+
The `codingbuddy.config.js` file customizes AI behavior:
70+
71+
```javascript
72+
module.exports = {
73+
// AI responds in this language
74+
language: 'en',
75+
76+
// Project metadata
77+
projectName: 'my-app',
78+
79+
// Technology stack
80+
techStack: {
81+
languages: ['TypeScript'],
82+
frontend: ['React', 'Next.js'],
83+
backend: ['Node.js'],
84+
},
85+
86+
// Architecture pattern
87+
architecture: {
88+
pattern: 'feature-sliced-design',
89+
},
90+
91+
// Coding conventions
92+
conventions: {
93+
naming: {
94+
files: 'kebab-case',
95+
components: 'PascalCase',
96+
},
97+
},
98+
99+
// Testing approach
100+
testStrategy: {
101+
approach: 'tdd',
102+
coverage: 80,
103+
},
104+
};
105+
```
106+
107+
See [Configuration Schema](./config-schema.md) for all options.
108+
109+
### Additional Context
110+
111+
Add project-specific documentation that AI should know about:
112+
113+
```
114+
my-project/
115+
├── codingbuddy.config.js
116+
└── .codingbuddy/
117+
└── context/
118+
├── architecture.md # System architecture docs
119+
└── api-conventions.md # API design guidelines
120+
```
121+
122+
### Ignore Patterns
123+
124+
Create `.codingignore` to exclude files from AI analysis:
125+
126+
```gitignore
127+
# Dependencies
128+
node_modules/
129+
130+
# Build output
131+
dist/
132+
.next/
133+
134+
# Sensitive files
135+
.env*
136+
*.pem
137+
```
138+
139+
## Using Workflow Modes
140+
141+
### PLAN Mode (Default)
142+
143+
Start with planning before making changes:
144+
145+
```
146+
You: PLAN Add dark mode support
147+
148+
AI: # Mode: PLAN
149+
150+
## Implementation Plan
151+
1. Create theme context...
152+
2. Add toggle component...
153+
3. Persist preference...
154+
```
155+
156+
### ACT Mode
157+
158+
Execute the plan with code changes:
159+
160+
```
161+
You: ACT
162+
163+
AI: # Mode: ACT
164+
165+
Creating theme context...
166+
[Makes code changes following TDD]
167+
```
168+
169+
### EVAL Mode
170+
171+
Review and improve implementation:
172+
173+
```
174+
You: EVAL
175+
176+
AI: # Mode: EVAL
177+
178+
## Code Review
179+
- ✅ Theme context properly typed
180+
- ⚠️ Consider adding system preference detection
181+
```
182+
183+
## Using Specialist Agents
184+
185+
Activate domain experts for specific tasks:
186+
187+
```
188+
You: Activate the security-specialist agent to review authentication
189+
190+
AI: [Activates security-specialist]
191+
192+
## Security Review
193+
- Password hashing: ✅ Using bcrypt
194+
- Session management: ⚠️ Consider shorter token expiry
195+
...
196+
```
197+
198+
Available specialists:
199+
200+
- `security-specialist` - Security audits
201+
- `performance-specialist` - Optimization
202+
- `accessibility-specialist` - WCAG compliance
203+
- `code-reviewer` - Code quality
204+
- And [other specialists](../.ai-rules/agents/README.md)
205+
206+
## Next Steps
207+
208+
- [Supported Tools](./supported-tools.md) - Setup guides for each AI tool
209+
- [Philosophy](./philosophy.md) - Understanding the design principles
210+
- [API Reference](./api.md) - MCP server capabilities
211+
- [Development Guide](./development.md) - Contributing to Codingbuddy

0 commit comments

Comments
 (0)