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

Anchors for messages, fields, enums, services #431

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jacobtolar
Copy link
Contributor

This adds additional anchor links in the HTML template to make sharing a link to a specific file, message, field, enum value, or service simpler.

Motivation: We have many protobufs with hundreds of fields, it would be nice to be able to link directly to a field rather than only a message.

  • Makes headers links so that if you scroll through the file and find one, you can easily grab a link directly to that section
  • Adds new links for fields, enum values, and services
  • Could also add links to individual service endpoints if that would be useful

If it would be preferable, I'd be happy to change this to use an icon or text next to the element rather than making the headers/fields themselves links. E.g.:

I also haven't added this here but could check in a simple CSS change to highlight the item you've navigated to, e.g.:

image

cc @pseudomuto -- I will push the remaining changes (e.g. test fixtures, generated resources, etc) once any discussion on how this should be displayed is resolved.

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