-
Notifications
You must be signed in to change notification settings - Fork 138
Generate doc from json schema #7275
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
begelundmuller
requested changes
May 7, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some inline comments below. But here are two overall comments when looking at the docs
- Can we use some kind of heading tags for the different properties? Or at least the top-level properties.
- The reason for this is that it will be very useful to be able to link directly to a property, so we want to output headings with an
id="property_name"
tag so we can get<url>#property_name
links directly to the properties.
- The reason for this is that it will be very useful to be able to link directly to a property, so we want to output headings with an
- When properties have oneofs, the layout becomes quite flat and it can be difficult to find out what they relate to. I'm wondering if different sizes, spacing or indentation could somehow make this easier to read. Maybe headings for top level properties would be enough. For example, see this screenshot:

begelundmuller
requested changes
May 20, 2025
begelundmuller
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1640
Checklist: