RuleStack

Configs

Stacks

Compare

Diff

RuleStack

Configs

Stacks

Compare

Diff

Read API

RuleStack

Configs

Stacks

Compare

Diff

Read API

Diff/herringtondarkholme-megarepo-clinerules-readme ↔ herringtondarkholme-megarepo-clinerules-03-documentation

Comparison

A · Cline rules · HerringtonDarkholme/megarepoB · Cline rules · HerringtonDarkholme/megarepo
What each file covers, counted
DimensionSharedOnly in AOnly in BOverlap
Sections06100%
Commands000—
Section tags0220%

What each file covers

Sections

0 shared · 6 only in A · 10 only in B
  • − Cline Rules for Megarepo
  • − Rules Structure
  • − How Cline Uses These Rules
  • − Customization
  • − Rules Bank Approach
  • − Consistency with Other AI Assistants
  • + Documentation Requirements
  • + Documentation Standards
  • + Update Requirements
  • + AI Service Documentation
  • + OpenAI Integration
  • + Common Errors
  • + Code Documentation
  • + Changelog Maintenance
  • + Architecture Decision Records (ADRs)
  • + Team Knowledge Sharing

Commands

neither file has any

Section tags

0 shared · 2 only in A · 2 only in B
  • − architecture
  • − do-not
  • + security
  • + docs

Line diff

+65 added−30 removed10 unchanged13.3% identical
HerringtonDarkholme/megarepo · .clinerules/README.md
@@ −1 @@
1# Cline Rules for Megarepo
2 
3This directory contains Cline Rules that provide system-level guidance for the Cline AI assistant when working on this AI setup repository.
 
4 
5## Rules Structure
 
 
 
 
6 
7The rules are organized into focused files that build upon each other:
 
8 
91. **`01-core-principles.md`** - Fundamental principles including minimal change philosophy and AI-first development
102. **`02-development.md`** - Development guidelines for Node.js/Next.js AI projects
113. **`03-documentation.md`** - Documentation requirements and standards
124. **`04-security.md`** - Security guidelines for AI projects and API key management
 
 
 
 
 
 
13 
14## How Cline Uses These Rules
 
 
 
 
 
 
 
 
 
 
 
 
15 
16Cline automatically processes all Markdown files in this directory, combining them into a unified set of rules. The numeric prefixes help organize the files in a logical sequence, ensuring core principles are established before specific guidelines.
 
 
 
 
 
 
 
 
17 
18## Customization
 
 
 
 
19 
20These rules are tailored specifically for the Megarepo AI setup repository and should be updated as the project evolves. The rules emphasize:
 
 
 
 
 
 
21 
22- **Minimal Changes**: Surgical, precise modifications that respect the repository's intentional simplicity
23- **AI-First Development**: Patterns and practices optimized for AI service integrations
24- **Security Best Practices**: Safe handling of API keys and sensitive data
25- **Node.js/Next.js Patterns**: Guidelines specific to the target technology stack
 
 
26 
27## Rules Bank Approach
28 
29This repository follows the "active rules" pattern where the `.clinerules/` directory contains only the rules that should be active. For projects with multiple contexts, consider creating a `clinerules-bank/` directory with additional rule sets that can be activated as needed.
30 
31## Consistency with Other AI Assistants
32 
33These rules are designed to work alongside other AI assistant configurations in this repository:
34- GitHub Copilot (`.github/copilot-instructions.md`)
35- Claude AI (`CLAUDE.md`)
36- Cursor AI (`.cursorrules`)
37- Gemini CLI (`GEMINI.md`)
38- Universal AI guidelines (`AGENT.md`, `AGENTS.md`)
39 
40All configurations share common principles while being optimized for each assistant's specific capabilities.
HerringtonDarkholme/megarepo · .clinerules/03-documentation.md
@@ +1 @@
1# Documentation Requirements
2 
3## Documentation Standards
4Maintain comprehensive documentation that supports both developers and AI assistants working on this project.
5 
6### Update Requirements
7- **README.md**: Update when adding significant functionality or changing project scope
8- **AI Configuration Files**: Keep all AI assistant configuration files current as project evolves
9- **Environment Documentation**: Maintain `.env.example` with all required variables documented
10- **API Documentation**: Document all AI service integrations and expected responses
11 
12### AI Service Documentation
13When integrating AI services, document:
14 
15#### Service Configuration
16```markdown
17## OpenAI Integration
18- **Model**: GPT-4 (configurable via environment)
19- **Rate Limits**: 500 requests/hour per API key
20- **Required Environment Variables**:
21 - `OPENAI_API_KEY`: Your OpenAI API key
22 - `OPENAI_MODEL`: Model to use (default: gpt-4)
23 - `OPENAI_MAX_TOKENS`: Maximum tokens per request (default: 2048)
24```
25 
26#### Usage Examples
27Always include practical examples:
28```javascript
29// Example: Basic AI chat completion
30const completion = await openai.chat.completions.create({
31 model: process.env.OPENAI_MODEL || "gpt-4",
32 messages: [
33 { role: "system", content: "You are a helpful AI assistant." },
34 { role: "user", content: userPrompt }
35 ],
36 max_tokens: parseInt(process.env.OPENAI_MAX_TOKENS) || 2048
37});
38```
39 
40#### Error Scenarios
41Document common error patterns and handling:
42```markdown
43### Common Errors
44- **401 Unauthorized**: Invalid API key or expired credentials
45- **429 Rate Limited**: Too many requests, implement exponential backoff
46- **500 Server Error**: AI service temporarily unavailable
47- **Context Length Exceeded**: Input too long for model context window
48```
49 
50## Code Documentation
51- Use JSDoc comments for complex AI algorithms and integrations
52- Document function parameters and return types for AI service calls
53- Include examples in code comments for non-obvious AI implementations
54- Explain AI model choice rationale and configuration decisions
55 
56## Changelog Maintenance
57When adding AI functionality, update documentation with:
58- New AI service integrations
59- Model version changes or updates
60- API endpoint modifications
61- Breaking changes to AI interfaces
62- Performance improvements or optimizations
63 
64## Architecture Decision Records (ADRs)
65For major AI-related decisions, create ADRs documenting:
66- Why specific AI models or services were chosen
67- Trade-offs between different AI providers
68- Performance and cost considerations
69- Security and privacy implications
70 
71## Team Knowledge Sharing
72- Document AI service setup steps for new team members
73- Include troubleshooting guides for common AI service issues
74- Maintain examples of successful AI integration patterns
75- Share lessons learned from AI service limitations and workarounds
 
 
 
 
 
 
 
 
 
@@ −1 +1 @@
1−# Cline Rules for Megarepo
1+# Documentation Requirements
22  
3−This directory contains Cline Rules that provide system-level guidance for the Cline AI assistant when working on this AI setup repository.
3+## Documentation Standards
4+Maintain comprehensive documentation that supports both developers and AI assistants working on this project.
45  
5−## Rules Structure
6+### Update Requirements
7+- **README.md**: Update when adding significant functionality or changing project scope
8+- **AI Configuration Files**: Keep all AI assistant configuration files current as project evolves
9+- **Environment Documentation**: Maintain `.env.example` with all required variables documented
10+- **API Documentation**: Document all AI service integrations and expected responses
611  
7−The rules are organized into focused files that build upon each other:
12+### AI Service Documentation
13+When integrating AI services, document:
814  
9−1. **`01-core-principles.md`** - Fundamental principles including minimal change philosophy and AI-first development
10−2. **`02-development.md`** - Development guidelines for Node.js/Next.js AI projects
11−3. **`03-documentation.md`** - Documentation requirements and standards
12−4. **`04-security.md`** - Security guidelines for AI projects and API key management
15+#### Service Configuration
16+```markdown
17+## OpenAI Integration
18+- **Model**: GPT-4 (configurable via environment)
19+- **Rate Limits**: 500 requests/hour per API key
20+- **Required Environment Variables**:
21+ - `OPENAI_API_KEY`: Your OpenAI API key
22+ - `OPENAI_MODEL`: Model to use (default: gpt-4)
23+ - `OPENAI_MAX_TOKENS`: Maximum tokens per request (default: 2048)
24+```
1325  
14−## How Cline Uses These Rules
26+#### Usage Examples
27+Always include practical examples:
28+```javascript
29+// Example: Basic AI chat completion
30+const completion = await openai.chat.completions.create({
31+ model: process.env.OPENAI_MODEL || "gpt-4",
32+ messages: [
33+ { role: "system", content: "You are a helpful AI assistant." },
34+ { role: "user", content: userPrompt }
35+ ],
36+ max_tokens: parseInt(process.env.OPENAI_MAX_TOKENS) || 2048
37+});
38+```
1539  
16−Cline automatically processes all Markdown files in this directory, combining them into a unified set of rules. The numeric prefixes help organize the files in a logical sequence, ensuring core principles are established before specific guidelines.
40+#### Error Scenarios
41+Document common error patterns and handling:
42+```markdown
43+### Common Errors
44+- **401 Unauthorized**: Invalid API key or expired credentials
45+- **429 Rate Limited**: Too many requests, implement exponential backoff
46+- **500 Server Error**: AI service temporarily unavailable
47+- **Context Length Exceeded**: Input too long for model context window
48+```
1749  
18−## Customization
50+## Code Documentation
51+- Use JSDoc comments for complex AI algorithms and integrations
52+- Document function parameters and return types for AI service calls
53+- Include examples in code comments for non-obvious AI implementations
54+- Explain AI model choice rationale and configuration decisions
1955  
20−These rules are tailored specifically for the Megarepo AI setup repository and should be updated as the project evolves. The rules emphasize:
56+## Changelog Maintenance
57+When adding AI functionality, update documentation with:
58+- New AI service integrations
59+- Model version changes or updates
60+- API endpoint modifications
61+- Breaking changes to AI interfaces
62+- Performance improvements or optimizations
2163  
22−- **Minimal Changes**: Surgical, precise modifications that respect the repository's intentional simplicity
23−- **AI-First Development**: Patterns and practices optimized for AI service integrations
24−- **Security Best Practices**: Safe handling of API keys and sensitive data
25−- **Node.js/Next.js Patterns**: Guidelines specific to the target technology stack
64+## Architecture Decision Records (ADRs)
65+For major AI-related decisions, create ADRs documenting:
66+- Why specific AI models or services were chosen
67+- Trade-offs between different AI providers
68+- Performance and cost considerations
69+- Security and privacy implications
2670  
27−## Rules Bank Approach
28− 
29−This repository follows the "active rules" pattern where the `.clinerules/` directory contains only the rules that should be active. For projects with multiple contexts, consider creating a `clinerules-bank/` directory with additional rule sets that can be activated as needed.
30− 
31−## Consistency with Other AI Assistants
32− 
33−These rules are designed to work alongside other AI assistant configurations in this repository:
34−- GitHub Copilot (`.github/copilot-instructions.md`)
35−- Claude AI (`CLAUDE.md`)
36−- Cursor AI (`.cursorrules`)
37−- Gemini CLI (`GEMINI.md`)
38−- Universal AI guidelines (`AGENT.md`, `AGENTS.md`)
39− 
40−All configurations share common principles while being optimized for each assistant's specific capabilities.
71+## Team Knowledge Sharing
72+- Document AI service setup steps for new team members
73+- Include troubleshooting guides for common AI service issues
74+- Maintain examples of successful AI integration patterns
75+- Share lessons learned from AI service limitations and workarounds
RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack

RuleStack

Built by

Kynth Studio

Directory

Configs
Stacks
Compare formats
Diff two configs
Best AGENTS.md examples

Formats

AGENTS.md
CLAUDE.md
Cursor rules
Copilot instructions

Reference

Read API
Corpus health
Privacy Policy
Terms

RuleStack