Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigation and anchor links formatting for GTFS Realtime reference #137

Open
emmambd opened this issue May 3, 2023 · 0 comments
Open

Navigation and anchor links formatting for GTFS Realtime reference #137

emmambd opened this issue May 3, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@emmambd
Copy link
Contributor

emmambd commented May 3, 2023

Feature request

Is your feature request related to a problem? Please describe.
GTFS Realtime documentation heavily relies on the element index, which has a nested structure. Right now the navigation for GTFS Realtime reference is not nested, which makes things confusing, especially when one submessage is duplicated and nested in multiple messages (e.g ScheduleRelationship).

Proposed solution

  • Update the Markdown and yaml nav config so the navigation and links are nested and clearly highlight the appropriate relationships, e.g https://gtfs.org/realtime/reference/#TripUpdates.msg-TripDescriptor.enum-schedulerelationship.

  • Stretch goal: update the navigation so it's nested

Describe alternatives you've considered
It doesn't look like anything fancier is needed aside from some info architecture changes, but this may be more complex to solve after more exploration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant