Thanks to visit codestin.com
Credit goes to github.com

Skip to content

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 20 commits into from
May 30, 2025
Merged

Conversation

NamanMahor
Copy link
Contributor

@NamanMahor NamanMahor commented May 6, 2025

Closes #1640

Checklist:

  • Covered by tests
  • Ran it and it works as intended
  • Reviewed the diff before requesting a review
  • Checked for unhandled edge cases
  • Linked the issues it closes
  • Checked if the docs need to be updated
  • Intend to cherry-pick into the release branch
  • I'm proud of this work!

@NamanMahor NamanMahor requested a review from begelundmuller May 6, 2025 20:56
@NamanMahor NamanMahor self-assigned this May 6, 2025
Copy link
Contributor

@begelundmuller begelundmuller left a comment

Choose a reason for hiding this comment

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

Can you also:

  1. Fix the lint errors on the PR
  2. Make sure the docs compile correctly so I can check how it renders 😄 You test with npm run dev --workspace docs
Screenshot 2025-05-07 at 12 14 36 Screenshot 2025-05-07 at 12 15 07

@NamanMahor NamanMahor requested a review from begelundmuller May 7, 2025 12:28
Copy link
Contributor

@begelundmuller begelundmuller left a 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

  1. 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.
  2. 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:
Screenshot 2025-05-08 at 22 16 52

@NamanMahor NamanMahor requested a review from begelundmuller May 17, 2025 21:52
@NamanMahor NamanMahor requested a review from begelundmuller May 29, 2025 08:03
@begelundmuller begelundmuller merged commit c161b8a into main May 30, 2025
10 checks passed
@begelundmuller begelundmuller deleted the generate_doc_from_json_schema branch May 30, 2025 15:28
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.

2 participants