Fix prose, link text, and markdown nits in docs/#1981
Conversation
|
Warning Review limit reached
Next review available in: 28 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughDocumentation updates correct wording, clarify GPS timing semantics, reformat issue-reporting examples, improve rebranding configuration guidance, fix relative links, and adjust architecture heading levels. ChangesDocumentation updates
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Wording and typos: - BETA_TESTING: "a issue" -> "an issue", "Github" -> "GitHub". - ISSUE_REPORTING: "include it in at the bottom" -> "include it at the bottom"; "runnign" -> "running". - README/ISSUE_REPORTING: replaced three generic [here] link texts with descriptive ones. Correctness: - DESTINATION_REMINDERS: the fourth log column is Location.elapsedRealtimeNanos, which counts from system boot, not from application start. Verified against NavigationService.writeToLog. Markdown hygiene: - SYSTEM_ARCHITECTURE: two #### headings under a ## became ###. - REBRANDING/ISSUE_REPORTING: tagged bare fences (text/properties). - REBRANDING: added alt text to the brand screenshot image. - REBRANDING: the google-services.json example was tagged json but held // comments and ... placeholders, so it could not parse. It now shows just the client-array entry as valid JSON, with placement described in prose. - REBRANDING: flavor-file references were stale paths in inline code; they are now working relative links. - REBRANDING: the brand list documents four flavors but only three have Play links, so the surrounding text no longer claims to cover all of them.
b055767 to
ff53cf7
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/REBRANDING.md`:
- Around line 121-122: Update the tutorial_background color placeholder in the
linked onebusaway-android/flavors README to use the same `#dfYOUR_PRIMARY_COLOR`
format as docs/REBRANDING.md, preserving the alpha prefix and consistent
replacement instruction.
- Around line 193-223: Update the instructions in the rebranding documentation
to state that the top-level project_info and existing entries in the client
array must remain untouched; clarify that only the new client object is appended
to client.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: ebe39652-a7ee-4c25-915e-3454be700cb6
📒 Files selected for processing (7)
README.mddocs/BETA_TESTING.mddocs/DESTINATION_REMINDERS.mddocs/ISSUE_REPORTING.mddocs/REBRANDING.mddocs/SYSTEM_ARCHITECTURE.mdonebusaway-android/flavors/README.md
…ording - flavors/README.md still showed #dfYOUR_PRIMARY while docs/REBRANDING.md was updated to #dfYOUR_PRIMARY_COLOR. Both guides now use the same placeholder, with the same comment explaining the df alpha prefix. - The google-services.json instruction read "leaving project_info and the other entries in that array untouched", which implies project_info lives inside the client array. It is a top-level property, alongside client and configuration_version. Reworded.
Follow-up to #1980, which relocated these files without touching their contents. This PR carries the content changes, so #1980 stays reviewable as a pure rename.
Stacked on
chore/move-gpx-files-to-tools; GitHub will retarget it tomainonce #1980 merges.Correctness
DESTINATION_REMINDERS.md described the fourth GPS-log column as "nanoseconds since the application started." It's
Location.elapsedRealtimeNanos, which counts from system boot. Verified againstNavigationService.writeToLog(NavigationService.kt:337), wherenanoTimeis written as the fourth field.REBRANDING.md's
google-services.jsonexample was tagged```jsonbut contained//comments and...placeholders, so it couldn't parse. It now shows just the object you append to theclientarray, as valid JSON, with placement described in prose.REBRANDING.md listed four brand flavors but only three Play Store links, then referred to "these 3 brands." The surrounding text no longer claims to cover all of them, and notes KiedyBus is third-party maintained.
Wording
[here]link texts replaced with descriptive ones (README.md, ISSUE_REPORTING.md ×2)Markdown hygiene
####headings directly under a##became###text/properties(REBRANDING.md, ISSUE_REPORTING.md)flavors/agencyX.gradle, actually underonebusaway-android/flavors/). They're now working relative links, so the link checker covers them going forward.Deliberately not changed
#dfYOUR_PRIMARYin thetutorial_backgroundexample was flagged as a malformed placeholder, but it isn't: every real flavor uses this shape —#dfF44336,#df2196F3,#df4CAF50— sodfis an alpha prefix (~87% opaque) on a 6-digit color. Dropping it to#YOUR_PRIMARY_COLORwould give anyone following the doc an opaque tutorial background. Kept the alpha, renamed the placeholder to#dfYOUR_PRIMARY_COLORfor consistency with its neighbors, and added a comment explaining the prefix.Verification
jsonblock parses viajson.loads../gradlew spotlessCheckpasses.🤖 Generated with Claude Code
Summary by CodeRabbit