docs: update CLAUDE.md with comprehensive codebase guide#803
Open
dmclane1B wants to merge 3 commits into
Open
Conversation
Replaces the minimal pointer-to-agents.md with a full reference covering repository structure, development setup, code quality tools (ruff, mypy, pre-commit), testing infrastructure, CI/CD workflows, architecture overview, and key conventions for AI assistants working on this codebase. https://claude.ai/code/session_01WcHXzuu7vwfmdxoLzYBXDs
Add a comprehensive set of help documentation targeting first-time users and common support scenarios: - HELP.md: First-run survival guide (box to first interaction) - HELP_HARDWARE.md: Specs, power, cables, do-not-do-this - HELP_SOFTWARE_SETUP.md: Python/uv/venv setup per OS - HELP_FIRST_MOTION.md: Safe first movements with code examples - HELP_CALIBRATION.md: Camera exposure, motor alignment, PID tuning - HELP_CONTROL_MODES.md: goto_target vs set_target decision guide - HELP_COMMON_ERRORS.md: Searchable error-to-fix reference - HELP_DEVELOPMENT_WORKFLOW.md: Project structure, sim-first, publishing - HELP_SAFETY.md: Pinch points, thermal limits, emergency stop - HELP_WHEN_THINGS_GO_WRONG.md: Calm recovery for common failure modes All content is specific to Reachy Mini with real API calls, motor IDs, PID values, and hardware specs drawn from the codebase. https://claude.ai/code/session_01WcHXzuu7vwfmdxoLzYBXDs
Add comprehensive architecture and internals documentation for contributors: - HELP_ARCHITECTURE.md: System mental map with block diagrams and subsystem descriptions - HELP_MODULE_BOUNDARIES.md: Module ownership, coupling rules, stable vs experimental APIs - HELP_STATE_MODEL.md: DaemonState, MotorControlMode, AppState machines with transitions - HELP_TIMING_AND_REALTIME.md: 20ms control loop budget, threading model, timing rules - HELP_DATA_FLOW.md: Zenoh topics, REST/WebSocket flow, camera/audio pipelines - HELP_EXTENSION_POINTS.md: 6 pluggable interfaces (app, kinematics, motion, backend, media, REST) - HELP_CONFIGURATION_MODEL.md: 3-layer config (hardcoded/boot-time/runtime), all CLI args - HELP_ERROR_HANDLING.md: 5 error categories, retry vs fail-fast rules, escalation paths - HELP_TESTING_STRATEGY.md: Test pyramid, CI commands, markers, test category examples - HELP_PERFORMANCE_BUDGETS.md: CPU/memory/network/thermal budgets, monitoring checklist All content derived from actual source code analysis with real class names, method signatures, constants, and code patterns. https://claude.ai/code/session_01WcHXzuu7vwfmdxoLzYBXDs
Contributor
|
Thanks for the contribution. We're working on a lighter files here #1059 Feel free to join the discussion |
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
3 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.
Replaces the minimal pointer-to-agents.md with a full reference covering repository structure, development setup, code quality tools (ruff, mypy, pre-commit), testing infrastructure, CI/CD workflows, architecture overview, and key conventions for AI assistants working on this codebase.
https://claude.ai/code/session_01WcHXzuu7vwfmdxoLzYBXDs