Windsurf rules
.windsurf/rules/documentation-standards.mdWindsurf rules
Quality
30/100
Scores the file, not the repository.Length
200 words
1 headings · 0 code blocksRepository
17
— · pushed 200 days agoLast changed
3 days ago
First indexed 3 days ago.1# Documentation Standards23**Activation Mode**: Glob4**Pattern**: `**/*.md`56<documentation_requirements>7- Update README.md when adding significant AI functionality or features8- Document AI service setup and configuration steps clearly9- Include examples of AI integrations and usage patterns10- Maintain consistency with existing documentation style and structure11- Document environment variable requirements for AI services12</documentation_requirements>1314<ai_documentation_specifics>15- Document all AI model dependencies and version requirements16- Include prompt engineering decisions and template explanations17- Explain AI service rate limiting and quota management approaches18- Provide troubleshooting guides for common AI integration issues19- Document performance considerations and optimization strategies20</ai_documentation_specifics>2122<code_documentation>23- Include JSDoc comments for AI-related functions and complex algorithms24- Document API endpoints with clear request/response examples25- Explain AI service authentication and configuration patterns26- Include usage examples for AI utility functions and client libraries27- Document data flow and processing pipelines for AI features28</code_documentation>2930<maintenance_guidelines>31- Keep documentation up to date with AI service API changes32- Document breaking changes and migration guides for AI integrations33- Include version compatibility information for AI service SDKs34- Maintain examples that work with current AI service APIs35- Document known limitations and workarounds for AI services36</maintenance_guidelines>
Also in HerringtonDarkholme/megarepo
Diff this repo’s formatsOne repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| HerringtonDarkholme/megarepo.clinerules/03-documentation.md · 17 | Cline rules | securitydocs | 50/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/code-quality.mdc · 17 | Cursor rules | teststyletypestesting-strategy+3 | 58/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/project-structure.mdc · 17 | Cursor rules | stylearchui | 66/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.github/copilot-instructions.md · 17 | Copilot instructions | setupbuildtestlint-format+7 | 100/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.clinerules/README.md · 17 | Cline rules | archdo-not | 55/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.clinerules/01-core-principles.md · 17 | Cline rules | gitsecuritydeploymentdo-not+1 | 51/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.clinerules/02-development.md · 17 | Cline rules | setupbuildteststyle+3 | 92/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.clinerules/04-security.md · 17 | Cline rules | setupstylesecurityapi+1 | 65/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/ai-development.mdc · 17 | Cursor rules | stylesecuritydependenciesapi+1 | 54/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/prompt-engineering.mdc · 17 | Cursor rules | teststylearch | 70/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/security.mdc · 17 | Cursor rules | setupstylesecuritydatabase+1 | 54/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursor/rules/testing-advanced.mdc · 17 | Cursor rules | teststyletesting-strategyperformance | 58/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.cursorrules · 17 | .cursorrules | setupbuildtestlint-format+13 | 96/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/README.md · 17 | Windsurf rules | typesdo-not | 51/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/ai-development-core.md · 17 | Windsurf rules | do-notdocs | 45/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/ai-optimization.md · 17 | Windsurf rules | no sections | 30/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/security-api-keys.md · 17 | Windsurf rules | securityapido-not | 37/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/testing-ai-components.md · 17 | Windsurf rules | testtesting-strategy | 34/100 | 3 days ago | |
| HerringtonDarkholme/megarepo.windsurf/rules/typescript-javascript.md · 17 | Windsurf rules | styletypesdo-not | 49/100 | 3 days ago | |
| HerringtonDarkholme/megarepoAGENTS.md · 17 | AGENTS.md | archagent-behaviour | 52/100 | 3 days ago |
Diff against .clinerules/03-documentation.md Diff against .cursor/rules/code-quality.mdc Diff against .cursor/rules/project-structure.mdc Diff against .github/copilot-instructions.md Diff against .clinerules/README.md Diff against .clinerules/01-core-principles.md Diff against .clinerules/02-development.md Diff against .clinerules/04-security.md Diff against .cursor/rules/ai-development.mdc Diff against .cursor/rules/prompt-engineering.mdc Diff against .cursor/rules/security.mdc Diff against .cursor/rules/testing-advanced.mdc Diff against .cursorrules Diff against .windsurf/rules/README.md Diff against .windsurf/rules/ai-development-core.md Diff against .windsurf/rules/ai-optimization.md Diff against .windsurf/rules/security-api-keys.md Diff against .windsurf/rules/testing-ai-components.md Diff against .windsurf/rules/typescript-javascript.md Diff against AGENTS.md
