Review documentation for best practices#7
Merged
martgra merged 1 commit intoNov 21, 2025
Conversation
High-priority fixes: - Fix incomplete sentence in README.md Architecture section - Add comprehensive Table of Contents to GUIDE.md - Clarify ChromaDB installation requirements (embedded vs server) - Standardize terminology across all documents - Add clear navigation guidance in README.md Enhancements: - Add helpful admonitions (warnings, notes, tips) throughout docs - Improve code examples in DEVELOPMENT.md with complete, runnable code - Fix inconsistent problem-solution formatting in GUIDE.md - Add note explaining 'prek' tool New documentation: - Create comprehensive CONTRIBUTING.md with: - Detailed contribution guidelines - Code quality standards - Testing requirements - Pull request process - Complete requirements checklist - Code style guide Structural improvements: - Reorganize DEVELOPMENT.md to focus on architecture and development - Move contribution guidelines and checklist to CONTRIBUTING.md - Add cross-references between documentation files - Improve document hierarchy and navigation
martgra
deleted the
claude/review-docs-best-practices-01421YHE9hLyQVCcsBupxh1V
branch
martgra
added a commit
that referenced
this pull request
Nov 22, 2025
…01421YHE9hLyQVCcsBupxh1V Review documentation for best practices
martgra
added a commit
that referenced
this pull request
Nov 22, 2025
…01421YHE9hLyQVCcsBupxh1V Review documentation for best practices
martgra
added a commit
that referenced
this pull request
Nov 28, 2025
…01421YHE9hLyQVCcsBupxh1V Review documentation for best practices
martgra
added a commit
that referenced
this pull request
Nov 28, 2025
…01421YHE9hLyQVCcsBupxh1V Review documentation for best practices
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.
High-priority fixes:
Enhancements:
New documentation:
Structural improvements: