Docs: Add CLAUDE.md guidance files for all modules #55
Conversation
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
Add comprehensive CLAUDE.md documentation files to guide AI-assisted development across all RapidFire modules. These files provide: - Module overviews and architecture - File-by-file documentation with purposes and key functions - Usage examples and common patterns - Integration points and dependencies - Best practices and testing guidance Files added: - CLAUDE.md (repository root) - rapidfireai/automl/CLAUDE.md - rapidfireai/backend/CLAUDE.md - rapidfireai/db/CLAUDE.md - rapidfireai/dispatcher/CLAUDE.md - rapidfireai/ml/CLAUDE.md - rapidfireai/utils/CLAUDE.md (includes Colab support documentation) These guidance files help Claude Code (and human developers) understand the codebase structure and make consistent, informed changes. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
pradyumna-rfai
approved these changes
Oct 6, 2025
Collaborator
pradyumna-rfai
left a comment
pradyumna-rfai
left a comment
There was a problem hiding this comment.
Can you also add the steps to update these docs for future PRs? Is there any formal way that Claude defines?
Contributor
Author
There is the Claude |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add comprehensive CLAUDE.md documentation files to guide AI-assisted development across all RapidFire modules. These files provide:
Files added:
These guidance files help Claude Code (and human developers) understand the codebase structure and make consistent, informed changes.
🤖 Generated with Claude Code