Skip to content

Fix prose, link text, and markdown nits in docs/#1981

Merged
bmander merged 2 commits into
mainfrom
docs/fix-doc-nits
Jul 21, 2026
Merged

Fix prose, link text, and markdown nits in docs/#1981
bmander merged 2 commits into
mainfrom
docs/fix-doc-nits

Conversation

@bmander

@bmander bmander commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

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 to main once #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 against NavigationService.writeToLog (NavigationService.kt:337), where nanoTime is written as the fourth field.

  • REBRANDING.md's google-services.json example was tagged ```json but contained // comments and ... placeholders, so it couldn't parse. It now shows just the object you append to the client array, 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

  • BETA_TESTING.md: "a issue" → "an issue", "Github" → "GitHub"
  • ISSUE_REPORTING.md: "include it in at the bottom" → "include it at the bottom"; "runnign" → "running"
  • Three generic [here] link texts replaced with descriptive ones (README.md, ISSUE_REPORTING.md ×2)

Markdown hygiene

  • SYSTEM_ARCHITECTURE.md: two #### headings directly under a ## became ###
  • Bare code fences tagged text / properties (REBRANDING.md, ISSUE_REPORTING.md)
  • Alt text added to the brand screenshot image in REBRANDING.md
  • REBRANDING.md's flavor-file references were stale paths in inline code (flavors/agencyX.gradle, actually under onebusaway-android/flavors/). They're now working relative links, so the link checker covers them going forward.

Deliberately not changed

#dfYOUR_PRIMARY in the tutorial_background example was flagged as a malformed placeholder, but it isn't: every real flavor uses this shape — #dfF44336, #df2196F3, #df4CAF50 — so df is an alpha prefix (~87% opaque) on a 6-digit color. Dropping it to #YOUR_PRIMARY_COLOR would give anyone following the doc an opaque tutorial background. Kept the alpha, renamed the placeholder to #dfYOUR_PRIMARY_COLOR for consistency with its neighbors, and added a comment explaining the prefix.

Verification

  • Every relative markdown link across all tracked docs resolves.
  • The json block parses via json.loads.
  • ./gradlew spotlessCheck passes.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Clarified the privacy explanation for requested device permissions.
    • Corrected wording and formatting in beta testing and issue-reporting guidance.
    • Updated GPS logging documentation to accurately describe elapsed time values.
    • Refined rebranding, Firebase, configuration, and architecture documentation.
    • Fixed a relative link in the flavors setup guide.

@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@bmander, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 28 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: e1d504c9-7e74-4583-ad94-46bf78458ff7

📥 Commits

Reviewing files that changed from the base of the PR and between ff53cf7 and 5b82713.

📒 Files selected for processing (2)
  • docs/REBRANDING.md
  • onebusaway-android/flavors/README.md
📝 Walkthrough

Walkthrough

Documentation updates correct wording, clarify GPS timing semantics, reformat issue-reporting examples, improve rebranding configuration guidance, fix relative links, and adjust architecture heading levels.

Changes

Documentation updates

Layer / File(s) Summary
General documentation corrections
README.md, docs/BETA_TESTING.md, docs/DESTINATION_REMINDERS.md, docs/SYSTEM_ARCHITECTURE.md
Permission explanations, feedback wording, GPS timestamp semantics, and architecture heading levels are updated.
Issue reporting examples
docs/ISSUE_REPORTING.md
Issue metadata examples are reformatted, example link labels are clarified, and a spelling error is corrected.
Rebranding and flavor setup guidance
docs/REBRANDING.md, onebusaway-android/flavors/README.md
Rebranding links, snippets, image metadata, Firebase instructions, Pelias formatting, flavor examples, and a relative link are updated.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation-only cleanup across prose, links, and Markdown fixes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/fix-doc-nits

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.

Base automatically changed from chore/move-gpx-files-to-tools to main July 21, 2026 15:53
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.
@bmander
bmander force-pushed the docs/fix-doc-nits branch from b055767 to ff53cf7 Compare July 21, 2026 15:55

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between e289853 and ff53cf7.

📒 Files selected for processing (7)
  • README.md
  • docs/BETA_TESTING.md
  • docs/DESTINATION_REMINDERS.md
  • docs/ISSUE_REPORTING.md
  • docs/REBRANDING.md
  • docs/SYSTEM_ARCHITECTURE.md
  • onebusaway-android/flavors/README.md

Comment thread docs/REBRANDING.md
Comment thread docs/REBRANDING.md Outdated
…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.
@bmander
bmander merged commit de6b47d into main Jul 21, 2026
1 of 2 checks passed
@bmander
bmander deleted the docs/fix-doc-nits branch July 21, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant