Skip to content

Rewrite the README for 1.9.0 - #23

Merged
LouisHitchcock merged 4 commits into
V1.9.0-alphafrom
feature/readme-seo
Oct 25, 2026
Merged

LouisHitchcock merged 4 commits into
V1.9.0-alphafrom
feature/readme-seo

Conversation

@LouisHitchcock

@LouisHitchcock LouisHitchcock commented Oct 25, 2026 •

Copy link
Copy Markdown
Owner

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

  • Header: no large logo. A tagline ("Scalable FPV race timing, from solo practice to 8-pilot club events"), badges, quick links, and a six-pilot race as the hero image.
  • Why FPVGate: led by industry-leading timing accuracy: on average, maximum lap-time deviation is 20 ms lower than an 8-node RX5808 timer's.
  • "From one pilot to a full club event": solo RX5808, up to 8 per gate with an ESP32-C5, Event Mode, and RotorHazard.
  • New 1.9.0 screenshots in screenshots/v1.9.0/: six-pilot race, Event Mode, race history, calibration, settings, single-pilot race, phone view, and a grid of six themes.
  • New themes section: 23 built-in themes plus custom colours. Also notes the five interface languages.
  • Get started covers the six 1.9.0 boards, the ESP32-C5 receiver and the C5 flasher. The XIAO ESP32S3 Plus and the deprecated I2S speaker are removed.
  • Rewritten FAQ and a "What's new in 1.9.0" section.
  • New social preview card (docs/social-preview.png).

Before merging

  • Timing accuracy figure verified (README "Why FPVGate" table and FAQ, and the social card)
  • 1.9.0 released; "What's new in 1.9.0" matches the final release notes
  • Upload docs/social-preview.png under Settings > General > Social preview

Notes

  • The screenshots come from the alpha-5 web UI served by a mock gate, using demo race data. The version is reported as 1.9.0.
  • All local links and images resolve, and every badge returns 200.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 25, 2026
@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e4a2e804-fa48-4396-bb85-c40df6d01058

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 0ea9cb79-28ec-4e35-87e7-cb5d8659e8cf
Commits

Reviewing files that changed from the base of the PR and between 20b7332 and 17ce0ed.

Files ignored due to path filters: 1
  • docs/social-preview.png is excluded by !**/*.png
Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The README has been reorganized with product information, setup instructions, channel lists, documentation links, FAQs, community links, credits, and updated release summaries.

Changes: README update

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: Low

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: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage Passed 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…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Title check Passed The title clearly and concisely describes the main change: rewriting the README for the 1.9.0 release.
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.

❤️ Share

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.
@LouisHitchcock LouisHitchcock changed the title Overhaul the README Rewrite the README for 1.9.0 Oct 25, 2026
@LouisHitchcock
LouisHitchcock changed the base branch from main to V1.9.0-alpha October 25, 2026 18:34
@LouisHitchcock
LouisHitchcock marked this pull request as draft October 25, 2026 18:34
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.
@LouisHitchcock
LouisHitchcock marked this pull request as ready for review October 25, 2026 19:15
@LouisHitchcock
LouisHitchcock merged commit dcc4fb4 into V1.9.0-alpha Oct 25, 2026
2 checks passed
@LouisHitchcock
LouisHitchcock deleted the feature/readme-seo branch October 25, 2026 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant