Tidy the repo root: move dev fixtures to tools/, contributor docs to docs/#1980
Conversation
The GPX files are mock-location fixtures for the Android emulator, not app resources — nothing in the build or the source tree reads them. They sit better next to the other developer tooling in tools/ (which already holds android-wait-for-emulator.sh), and it drops one more entry from a crowded repo root. Pure move; the README's links are intra-folder relative paths and still resolve.
📝 WalkthroughWalkthroughDocumentation links and technical guidance were updated across repository guides, issue reporting, rebranding, server configuration, and troubleshooting. GPX usage documentation and emulator fixture tracks were added. ChangesDocumentation link migration
Guide content corrections
GPX emulator fixtures
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Nine markdown files that README links into — BUILD, TROUBLESHOOTING, FAQ, REBRANDING, BETA_TESTING, ISSUE_REPORTING, CUSTOM_SERVERS, DESTINATION_REMINDERS, SYSTEM_ARCHITECTURE — move out of the repo root into docs/. README.md, LICENSE, CONTRIBUTORS.md and CLAUDE.md stay at root, where GitHub and tooling expect them. PRIVACY.md also stays: it's plausibly the privacy-policy URL registered in the Play Console, and moving it would break an external link that isn't verifiable from the repo. Link updates: - README/BUILD absolute github.com/blob/main/ URLs to moved files are now relative, so they can't silently 404 on a future move. - Links from inside docs/ to source-tree paths gained a ../ prefix. Also fixes two links that were already broken before this move: - FAQ.md pointed at PERMISSIONS.md, renamed to PRIVACY.md in 3967a6d. - BETA_TESTING.md pointed at a root CONTRIBUTING.md, which lives in .github/. Verified every relative markdown link in the repo resolves.
bmander
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 12
🤖 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/BETA_TESTING.md`:
- Line 47: Update the user-facing wording in the issue-tracker bullet to use “an
issue” and the correct capitalization “GitHub,” while preserving the existing
link and meaning.
In `@docs/DESTINATION_REMINDERS.md`:
- Around line 49-54: Update the fourth column description in
DESTINATION_REMINDERS.md to state that the nanosecond timestamp represents
elapsed time since system boot, matching Location.elapsedRealtimeNanos; leave
the other column descriptions unchanged.
In `@docs/ISSUE_REPORTING.md`:
- Line 17: Update the issue-reporting documentation wording: change “include it
in at the bottom” to “include it at the bottom” and correct “runnign” to
“running”.
- Around line 21-30: Update the fenced blocks at docs/ISSUE_REPORTING.md lines
21-30 to use the text language identifier, docs/REBRANDING.md lines 83-94 to use
text, and docs/REBRANDING.md lines 307-309 to use properties, preserving each
block’s content.
In `@docs/REBRANDING.md`:
- Line 31: Update the image element in REBRANDING.md to include meaningful alt
text describing the brand screenshots, while preserving the existing source,
dimensions, and alignment attributes.
- Line 121: Update the tutorial_background color value in the rebranding
documentation to replace the malformed `#dfYOUR_PRIMARY` placeholder with the
consistent `#YOUR_PRIMARY_COLOR` placeholder or another valid hex example.
- Around line 23-31: Update the brand examples in the documentation around the
Google Play links and screenshot section to be consistent with the four
documented flavors, including kiedybus in the listed links and screenshot
context, or explicitly describe the existing three as sample brands. Keep the
chosen wording and counts consistent throughout this section.
- Line 77: Update the flavor-file links in docs/REBRANDING.md, including the
references around the flavor configuration options and lines 316–318, to resolve
from docs/ into onebusaway-android/flavors/. Use the correct
../onebusaway-android/flavors/ relative prefix for README.md, agencyX.gradle,
and the other affected flavor files.
- Around line 194-230: Update the google-services.json example in REBRANDING.md
to be parseable JSON by removing inline // comments and ellipsis placeholders,
replacing them with valid JSON values or moving explanatory notes outside the
code block. Preserve the example’s required Firebase configuration structure and
placeholders.
In `@docs/SYSTEM_ARCHITECTURE.md`:
- Line 38: Update the “OneBusAway and OpenTripPlanner” heading in the
architecture documentation from level four to level three so it follows the
preceding level-two heading without skipping a level.
In `@onebusaway-android/flavors/README.md`:
- Line 106: Update the documentation link in the flavors README to reference the
repository-root docs/REBRANDING.md location by navigating up from the flavors
directory, while preserving the surrounding Firebase configuration guidance.
In `@README.md`:
- Line 53: Replace the generic [here] link in README.md at lines 53-53 with
descriptive text such as “privacy explanation.” Also update both [here] links in
docs/ISSUE_REPORTING.md at lines 26-48 to describe the linked example reports.
🪄 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: 6a245490-8f1f-404a-b784-835369a1853d
📒 Files selected for processing (23)
CLAUDE.mdREADME.mddocs/BETA_TESTING.mddocs/BUILD.mddocs/CUSTOM_SERVERS.mddocs/DESTINATION_REMINDERS.mddocs/FAQ.mddocs/ISSUE_REPORTING.mddocs/REBRANDING.mddocs/SYSTEM_ARCHITECTURE.mddocs/TROUBLESHOOTING.mdonebusaway-android/flavors/README.mdonebusaway-android/src/androidTest/java/org/onebusaway/android/nav/test/NavigationTest.javaonebusaway-android/src/main/java/org/onebusaway/android/ui/compose/theme/ObaTheme.kttools/gpx/README.mdtools/gpx/atlanta.gpxtools/gpx/capitolhill.gpxtools/gpx/invalid.gpxtools/gpx/rvtd.gpxtools/gpx/sandiego.gpxtools/gpx/tampa.gpxtools/gpx/washingtondc.gpxtools/gpx/yorkca.gpx
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's internal server error or limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 12
🤖 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/BETA_TESTING.md`:
- Line 47: Update the user-facing wording in the issue-tracker bullet to use “an
issue” and the correct capitalization “GitHub,” while preserving the existing
link and meaning.
In `@docs/DESTINATION_REMINDERS.md`:
- Around line 49-54: Update the fourth column description in
DESTINATION_REMINDERS.md to state that the nanosecond timestamp represents
elapsed time since system boot, matching Location.elapsedRealtimeNanos; leave
the other column descriptions unchanged.
In `@docs/ISSUE_REPORTING.md`:
- Line 17: Update the issue-reporting documentation wording: change “include it
in at the bottom” to “include it at the bottom” and correct “runnign” to
“running”.
- Around line 21-30: Update the fenced blocks at docs/ISSUE_REPORTING.md lines
21-30 to use the text language identifier, docs/REBRANDING.md lines 83-94 to use
text, and docs/REBRANDING.md lines 307-309 to use properties, preserving each
block’s content.
In `@docs/REBRANDING.md`:
- Line 31: Update the image element in REBRANDING.md to include meaningful alt
text describing the brand screenshots, while preserving the existing source,
dimensions, and alignment attributes.
- Line 121: Update the tutorial_background color value in the rebranding
documentation to replace the malformed `#dfYOUR_PRIMARY` placeholder with the
consistent `#YOUR_PRIMARY_COLOR` placeholder or another valid hex example.
- Around line 23-31: Update the brand examples in the documentation around the
Google Play links and screenshot section to be consistent with the four
documented flavors, including kiedybus in the listed links and screenshot
context, or explicitly describe the existing three as sample brands. Keep the
chosen wording and counts consistent throughout this section.
- Line 77: Update the flavor-file links in docs/REBRANDING.md, including the
references around the flavor configuration options and lines 316–318, to resolve
from docs/ into onebusaway-android/flavors/. Use the correct
../onebusaway-android/flavors/ relative prefix for README.md, agencyX.gradle,
and the other affected flavor files.
- Around line 194-230: Update the google-services.json example in REBRANDING.md
to be parseable JSON by removing inline // comments and ellipsis placeholders,
replacing them with valid JSON values or moving explanatory notes outside the
code block. Preserve the example’s required Firebase configuration structure and
placeholders.
In `@docs/SYSTEM_ARCHITECTURE.md`:
- Line 38: Update the “OneBusAway and OpenTripPlanner” heading in the
architecture documentation from level four to level three so it follows the
preceding level-two heading without skipping a level.
In `@onebusaway-android/flavors/README.md`:
- Line 106: Update the documentation link in the flavors README to reference the
repository-root docs/REBRANDING.md location by navigating up from the flavors
directory, while preserving the surrounding Firebase configuration guidance.
In `@README.md`:
- Line 53: Replace the generic [here] link in README.md at lines 53-53 with
descriptive text such as “privacy explanation.” Also update both [here] links in
docs/ISSUE_REPORTING.md at lines 26-48 to describe the linked example reports.
🪄 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: 6a245490-8f1f-404a-b784-835369a1853d
📒 Files selected for processing (23)
CLAUDE.mdREADME.mddocs/BETA_TESTING.mddocs/BUILD.mddocs/CUSTOM_SERVERS.mddocs/DESTINATION_REMINDERS.mddocs/FAQ.mddocs/ISSUE_REPORTING.mddocs/REBRANDING.mddocs/SYSTEM_ARCHITECTURE.mddocs/TROUBLESHOOTING.mdonebusaway-android/flavors/README.mdonebusaway-android/src/androidTest/java/org/onebusaway/android/nav/test/NavigationTest.javaonebusaway-android/src/main/java/org/onebusaway/android/ui/compose/theme/ObaTheme.kttools/gpx/README.mdtools/gpx/atlanta.gpxtools/gpx/capitolhill.gpxtools/gpx/invalid.gpxtools/gpx/rvtd.gpxtools/gpx/sandiego.gpxtools/gpx/tampa.gpxtools/gpx/washingtondc.gpxtools/gpx/yorkca.gpx
🛑 Comments failed to post (12)
docs/BETA_TESTING.md (1)
47-47: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the user-facing wording.
Use “Filing an issue on the OBA Android GitHub issue tracker”.
Proposed fix
-* Filing a issue on the [OBA Android Github issue tracker](../.github/CONTRIBUTING.md#issue-tracker) +* Filing an issue on the [OBA Android GitHub issue tracker](../.github/CONTRIBUTING.md#issue-tracker)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.* Filing an issue on the [OBA Android GitHub issue tracker](../.github/CONTRIBUTING.md#issue-tracker)🧰 Tools
🪛 LanguageTool
[uncategorized] ~47-~47: The official name of this software platform is spelled with a capital “H”.
Context: ...s) * Filing a issue on the [OBA Android Github issue tracker](../.github/CONTRIBUTING....(GITHUB)
[uncategorized] ~47-~47: The official name of this software platform is spelled with a capital “H”.
Context: ...on the OBA Android Github issue tracker(GITHUB)
🤖 Prompt for 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. In `@docs/BETA_TESTING.md` at line 47, Update the user-facing wording in the issue-tracker bullet to use “an issue” and the correct capitalization “GitHub,” while preserving the existing link and meaning.Source: Linters/SAST tools
docs/DESTINATION_REMINDERS.md (1)
49-54: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Correct the description of the nanoseconds time column.
The documentation describes the fourth column as "the time in nanoseconds since the application started". The implementation writes
Location.elapsedRealtimeNanos, which represents the time since system boot, not since the application started.📝 Proposed tweak
1. coordinateID - unique ID for each location fix in the file 1. getReadyFlag - true if the "Get Ready" alert has been announced to the user, false if it has not 1. pullTheCordNowFlag - true if the "Pull the Cord Now" alert has been announced to the user, false if it has not -1. the time in nanoseconds since the application started +1. the time in nanoseconds since system boot 1. the time in UTC 1. latitude📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.1. coordinateID - unique ID for each location fix in the file 1. getReadyFlag - true if the "Get Ready" alert has been announced to the user, false if it has not 1. pullTheCordNowFlag - true if the "Pull the Cord Now" alert has been announced to the user, false if it has not 1. the time in nanoseconds since system boot 1. the time in UTC 1. latitude🤖 Prompt for 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. In `@docs/DESTINATION_REMINDERS.md` around lines 49 - 54, Update the fourth column description in DESTINATION_REMINDERS.md to state that the nanosecond timestamp represents elapsed time since system boot, matching Location.elapsedRealtimeNanos; leave the other column descriptions unchanged.docs/ISSUE_REPORTING.md (2)
17-17: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the documentation wording.
Change “include it in at the bottom” to “include it at the bottom”, and correct “runnign” to “running”.
Also applies to: 43-43
🤖 Prompt for 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. In `@docs/ISSUE_REPORTING.md` at line 17, Update the issue-reporting documentation wording: change “include it in at the bottom” to “include it at the bottom” and correct “runnign” to “running”.
21-30: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add language identifiers to all affected fenced blocks.
These fences trigger the same MD040 lint issue.
docs/ISSUE_REPORTING.md#L21-L30: mark both metadata fences astext.docs/REBRANDING.md#L83-L94: mark the resource-tree fence astext.docs/REBRANDING.md#L307-L309: mark the properties fence asproperties.🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 21-21: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
[warning] 26-26: Link text should be descriptive
(MD059, descriptive-link-text)
[warning] 30-30: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
📍 Affects 2 files
docs/ISSUE_REPORTING.md#L21-L30(this comment)docs/REBRANDING.md#L83-L94docs/REBRANDING.md#L307-L309🤖 Prompt for 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. In `@docs/ISSUE_REPORTING.md` around lines 21 - 30, Update the fenced blocks at docs/ISSUE_REPORTING.md lines 21-30 to use the text language identifier, docs/REBRANDING.md lines 83-94 to use text, and docs/REBRANDING.md lines 307-309 to use properties, preserving each block’s content.Source: Linters/SAST tools
docs/REBRANDING.md (5)
23-31: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Make the listed brand examples consistent.
The guide lists four brand flavors, including
kiedybus, but then says there are three brands and omits KiedyBus from the Play Store links and screenshot context. Either document all four or explicitly call these three sample brands.🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 31-31: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for 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. In `@docs/REBRANDING.md` around lines 23 - 31, Update the brand examples in the documentation around the Google Play links and screenshot section to be consistent with the four documented flavors, including kiedybus in the listed links and screenshot context, or explicitly describe the existing three as sample brands. Keep the chosen wording and counts consistent throughout this section.
31-31: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add alternate text to the image.
Provide meaningful
alttext for the brand screenshots to satisfy MD045 and improve accessibility.🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 31-31: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for 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. In `@docs/REBRANDING.md` at line 31, Update the image element in REBRANDING.md to include meaningful alt text describing the brand screenshots, while preserving the existing source, dimensions, and alignment attributes.Source: Linters/SAST tools
77-77: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the flavor-file paths relative to
docs/REBRANDING.md.These paths currently resolve under
docs/, but the files are underonebusaway-android/flavors/. Use paths such as../onebusaway-android/flavors/README.mdand../onebusaway-android/flavors/agencyX.gradle.Also applies to: 316-318
🤖 Prompt for 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. In `@docs/REBRANDING.md` at line 77, Update the flavor-file links in docs/REBRANDING.md, including the references around the flavor configuration options and lines 316–318, to resolve from docs/ into onebusaway-android/flavors/. Use the correct ../onebusaway-android/flavors/ relative prefix for README.md, agencyX.gradle, and the other affected flavor files.
121-121: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct the malformed color placeholder.
#dfYOUR_PRIMARYis not a valid color value and is inconsistent with the other placeholders. Use a clear placeholder such as#YOUR_PRIMARY_COLORor provide a valid hex example.🤖 Prompt for 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. In `@docs/REBRANDING.md` at line 121, Update the tutorial_background color value in the rebranding documentation to replace the malformed `#dfYOUR_PRIMARY` placeholder with the consistent `#YOUR_PRIMARY_COLOR` placeholder or another valid hex example.
194-230: 🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Make the
google-services.jsonexample valid JSON.The block contains
//comments and..., which are invalid JSON. Users copying this example intogoogle-services.jsonwill receive a parse failure. Use a valid JSON example, or move explanatory placeholders outside the JSON block.🤖 Prompt for 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. In `@docs/REBRANDING.md` around lines 194 - 230, Update the google-services.json example in REBRANDING.md to be parseable JSON by removing inline // comments and ellipsis placeholders, replacing them with valid JSON values or moving explanatory notes outside the code block. Preserve the example’s required Firebase configuration structure and placeholders.docs/SYSTEM_ARCHITECTURE.md (1)
38-38: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the heading level.
#### OneBusAway and OpenTripPlannerfollows an##heading, so make it###to avoid skipping a heading level.🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
🤖 Prompt for 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. In `@docs/SYSTEM_ARCHITECTURE.md` at line 38, Update the “OneBusAway and OpenTripPlanner” heading in the architecture documentation from level four to level three so it follows the preceding level-two heading without skipping a level.Source: Linters/SAST tools
onebusaway-android/flavors/README.md (1)
106-106: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix the relative path to
REBRANDING.md.Since this
README.mdis located in theonebusaway-android/flavors/directory, the relative pathdocs/REBRANDING.mdwill resolve toonebusaway-android/flavors/docs/REBRANDING.md, resulting in a broken link. It should be updated to point to the repository root.🐛 Proposed fix
-Add your app's Firebase client info to `google-services.json`. See `docs/REBRANDING.md` for detailed instructions. +Add your app's Firebase client info to `google-services.json`. See `../../docs/REBRANDING.md` for detailed instructions.🤖 Prompt for 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. In `@onebusaway-android/flavors/README.md` at line 106, Update the documentation link in the flavors README to reference the repository-root docs/REBRANDING.md location by navigating up from the flavors directory, while preserving the surrounding Firebase configuration guidance.README.md (1)
53-53: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use descriptive link text for all affected documentation links.
README.md#L53-L53: replace[here]with a label such as[privacy explanation].docs/ISSUE_REPORTING.md#L26-L48: replace both[here]labels with descriptions of the linked example reports.🧰 Tools
🪛 markdownlint-cli2 (0.23.0)
[warning] 53-53: Link text should be descriptive
(MD059, descriptive-link-text)
📍 Affects 2 files
README.md#L53-L53(this comment)docs/ISSUE_REPORTING.md#L26-L48🤖 Prompt for 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. In `@README.md` at line 53, Replace the generic [here] link in README.md at lines 53-53 with descriptive text such as “privacy explanation.” Also update both [here] links in docs/ISSUE_REPORTING.md at lines 26-48 to describe the linked example reports.Source: Linters/SAST tools
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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 23-27: Update the download list in the rebranding documentation to
remove the fictitious Agency X and Agency Y Google Play links, or clearly label
them as unpublished samples; retain only verified published apps as downloadable
entries.
🪄 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: c8ce96f0-f383-4ade-b118-84cfb4e0693d
📒 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
🚧 Files skipped from review as they are similar to previous changes (3)
- onebusaway-android/flavors/README.md
- docs/SYSTEM_ARCHITECTURE.md
- README.md
| Here's where you can download three of these brands on Google Play (KiedyBus is maintained by a third party and isn't listed here): | ||
|
|
||
| * [OneBusAway](https://play.google.com/store/apps/details?id=com.joulespersecond.seattlebusbot) | ||
| * [Agency X](https://play.google.com/store/apps/details?id=org.agencyx.android) | ||
| * [Agency Y](https://play.google.com/store/apps/details?id=org.agencyy.android) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Do not present fictitious sample brands as downloadable apps.
Lines 19-20 define Agency X and Agency Y as fictitious, but this section presents them as Google Play downloads. Remove those links or label them as unpublished samples; only list verified published apps as downloads.
🤖 Prompt for 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.
In `@docs/REBRANDING.md` around lines 23 - 27, Update the download list in the
rebranding documentation to remove the fictitious Agency X and Agency Y Google
Play links, or clearly label them as unpublished samples; retain only verified
published apps as downloadable entries.
b055767 to
8192651
Compare
1 participant
Two moves that clear out a repo root carrying 14 top-level markdown files plus a loose fixtures folder. No content changes beyond link fixes; git recorded every file as a rename, so
git log --followhistory survives.gpx_files/→tools/gpx/These are mock-location fixtures for the Android emulator — you load one via Extended Controls → Location to drop the emulator into a given OBA region. They aren't app resources: nothing in the build scripts, source tree, or tests references them.
tools/already holds emulator-adjacent dev tooling (android-wait-for-emulator.sh,missing_localizations.sh), so they sit better there.Explicitly not moved under
onebusaway-android/src/, since every subdirectory there means something to AGP:src/main/assets/orres/raw/would ship them inside the APK for no reason, andsrc/androidTest/assets/would imply an instrumented test reads them — none does, as the emulator's GPX import happens outside the app process entirely.Nine contributor docs →
docs/BUILD,TROUBLESHOOTING,FAQ,REBRANDING,BETA_TESTING,ISSUE_REPORTING,CUSTOM_SERVERS,DESTINATION_REMINDERS,SYSTEM_ARCHITECTURE.Staying at root:
README.md,LICENSE,CONTRIBUTORS.md(GitHub renders these specially) andCLAUDE.md(tooling expects it there).PRIVACY.mdalso stays — there's no Play listing metadata in the repo to check against, but a privacy-policy URL is exactly the kind of thing registered in the Play Console. Moving it risks breaking an external link that can't be verified from here, for no real gain.Link updates
github.com/.../blob/main/...absolute URLs in README and BUILD pointed at moved files and would have 404'd silently. They're now relative, so a future move can't break them quietly the same way.docs/out to source-tree paths (onebusaway-android/build.gradle.ktsetc.) gained a../prefix.CLAUDE.md,flavors/README.md,NavigationTest.java, andObaTheme.ktupdated.Two pre-existing broken links, fixed in passing
Not caused by this move — found while auditing:
FAQ.mdlinked toPERMISSIONS.md, which was renamed toPRIVACY.mdback in 3967a6d.BETA_TESTING.mdlinked to a rootCONTRIBUTING.md; it lives in.github/.While in
TROUBLESHOOTING.mdI also refreshed a stale reference tocompileSdkVersioninbuild.gradle— that'scompileSdkinbuild.gradle.ktsnow.Verification
.github/CONTRIBUTING.md) returns 200../gradlew spotlessCheckpasses — the two touched source files are comment-only edits.🤖 Generated with Claude Code
Summary by CodeRabbit
docs/paths for rebranding, issue reporting, beta feedback, build setup, troubleshooting, permissions, and destination reminders.