Repository navigation
Set up AI Agent response handling - #7
Merged
tirthbodawala merged 3 commits intoNov 5, 2025
Merged
Conversation
Add comprehensive documentation-first approach to prevent AI agents from over-engineering and reinventing the wheel. This addresses the issue where agents would manually implement APIs instead of discovering existing built-in tools and framework features. **New Documentation:** - Created AI_DOCS/documentation-first-approach.md with complete guidelines - Detailed workflow: MCP tools → official docs → tutorials → verify no built-in - Real-world examples (e.g., Agno HackerNews case study) - Decision matrices and success criteria **Updated Core Files:** - CLAUDE.md: Added CRITICAL documentation-first section as secondary directive - AGENTS.md: Added documentation-first approach and updated quick reference - AI_DOCS/ai-tools.md: Added mandatory documentation-first section - AI_DOCS/README.md: Added new file to documentation list **Updated AI Tool Configs:** - .gemini/styleguide.md: Added brief documentation-first section (synced 2025-11-05) - .github/copilot-instructions.md: Added documentation-first guidance (synced 2025-11-05) - Both include references to full guidelines in AI_DOCS **Template Updates:** - template/CLAUDE.md.jinja: Added documentation-first approach - template/AGENTS.md.jinja: Added documentation-first with quick reference - template/AI_DOCS/*.jinja: Synced all documentation files - template/.gemini/: Copied updated styleguide.md - template/.github/: Copied updated copilot-instructions.md **Quality Gates:** - Updated Quality Gates Checklist to include mandatory documentation research - Added to workflow: Phase 0 (Documentation Discovery) before TDD phases - All quality checks pass (200 tests, 86% coverage) **Key Features:** - Prioritizes MCP tools for documentation fetching - Requires WebFetch/WebSearch before implementation - Prevents reverse-engineering when official docs exist - Emphasizes using framework built-ins over custom code This ensures all AI agents (Claude, Gemini, Copilot, Cursor, Aider) follow a consistent documentation-first approach across both the current codebase and all future projects created from the template.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.