Repository navigation
Rewrite the README for 1.9.0 - #23
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the
|
| Layer / File(s) | Summary |
|---|---|
Product overview and setup README.md |
The README presents revised product information and setup steps. It adds FAQ and release-summary sections, including details about 1.9 pre-releases, and removes the former project-status section and older release notes. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Merge Risk: 
Minimal · up to 17ce0
-
No merge-blocking risk introduced by this documentation-only change was established.
Pre-merge checks: 
5
-
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
Lead with scalable race timing and timing accuracy: a feature table, a one-pilot-to-club-event table, Event Mode, ESP32-C5 multi-pilot setup, the six 1.9.0 boards, and an FAQ. Drop the large logo header, the deprecated I2S speaker and the XIAO ESP32S3 Plus. Replace the screenshots with 1.9.0 captures: a six-pilot race, Event Mode, race history, calibration, settings, a phone view and a grid of six themes. Add a 1280x640 social preview card.
17ce0ed to
08d946b
Compare
Replace the full-size race screenshot at the top with a banner in the social card's style, and move the screenshot to the Screenshots section. Add low cost to the intro and the feature table, and say "spoken lap times" instead of "voice calls". Drop themes from the social card and add low-cost hardware to it.
Ships with v1.9.0. The README is written as if 1.9.0 is already released. Don't merge until 1.9.0 is out and the timing accuracy figure has been verified.
Summary
screenshots/v1.9.0/: six-pilot race, Event Mode, race history, calibration, settings, single-pilot race, phone view, and a grid of six themes.docs/social-preview.png).Before merging
docs/social-preview.pngunder Settings > General > Social previewNotes