docs: add developer guid and code-flow diagram#250
Open
Sharron4me wants to merge 3 commits into
Open
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
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.
Changes
Adds two new documentation files under docs/ aimed at engineers landing in the repo for the first time:
Documentation-only. No source, configuration, dependency, or build changes. No runtime behavior is affected.
Changelog Content
Additions
Fixes
Testing
Screenshots (if applicable)
Add screenshots to help explain your changes.
N/A — diagram is inline mermaid in docs/code-flow.md and renders on GitHub.
Checklist
Performance Impact
None. Documentation-only change.
Note
Low Risk
Documentation-only changes that update developer guidance and add new diagrams; no runtime or build logic is modified.
Overview
Adds two new onboarding docs:
docs/DEVELOPER.md(end-to-endExperiment.run_fit()walkthrough withpath:linecitations) anddocs/CodeFlow.md(Mermaid diagram of the same execution flow).Updates
CLAUDE.mdto link to these docs, refresh architecture/DB schema references to therapidfireai/fit+rapidfireai/evalslayout, and fixes command/script paths (e.g.,setup/fit/start_dev.sh,setup/bump_version.sh).Reviewed by Cursor Bugbot for commit 0e81aaa. Bugbot is set up for automated code reviews on this repo. Configure here.