json-schema-org
[📝 Docs]: Add sub-navigation menu in the "JSON data types" portion of the docs
What Docs changes are you proposing?
The "JSON data types" part of the documentation is quite difficult to use.
As an example, let's say I want to read about the "object" type.
There's no way to see what the general sub-sections of the object documentation is. Things like Required Properties, Property Names, Size, Pattern Properties, etc.
It would be incredibly helpful to have a little contents menu (wikipedia-style) at the top of each major JSON Schema data type.
That way someone who is new to the schema can quickly explore the features, configurations, etc. of each major type.
For context: I use JSON Schema only for OpenAI tool definitions so I may not be the most "ideal" user. However, in general, writing schemas seems to be a big part of the use cases and currently the documentation isn't easy to traverse when trying to write schemas, expand schemas, or just learn and create more advanced ones.
Over the last year I've noticed the left-side navigation hasn't changed but the data type schemas seem to be growing with more and more features. In the proposed contents menu at the top you could even use badges to indicate new additions, draft specific ones, etc.
Thank you for your consideration!
Code of Conduct
- [x] I agree to follow this project's Code of Conduct
Hi @jrclaypool , thank you so much for opening this issue and guiding me here 🌸. I agree — navigating within the JSON data types section can feel a bit overwhelming as the content grows.
My first step will be to explore whether the docs system supports an auto-generated mini table of contents from existing headings. If yes, I’ll try enabling it. If not, I’ll draft a small manual sub-navigation menu (wikipedia-style) at the top of each major type page (object, array, string, etc.) so readers can quickly explore key sections like Required Properties, Pattern Properties, Size, etc.
I’ll start with the object type as an example and share progress here soon 🌱.
Hi @jrclaypool and @riyap03 !
Hope you're both doing well! I'm interested in contributing to this issue and have experience with Next.js, Tailwind, and shadcn/ui.
@riyap03 - I saw your comment from August. Are you still actively working on this? If you're busy or moved on to other things, I'd be happy to pick it up! Or if you'd like, we could collaborate and split the work across different data types.
I've got the repo set up locally and I'm ready to dive in whenever works best. Let me know what you think! 😊
@Suyog241005 Hello 👋 Good to meet you! I've not had any time to devote to this, so please... dive in! 🏊
Hi maintainer @jrclaypool if this issue still opens i would love to work on it please assign me
hi @riyap03 and @jrclaypool , i have just created the pull request and all the checks have passed but got 2 codecov checks failed, how to solve that? Actually i dont have any idea about that.
Hey @Suyog241005, I really appreciate your effort in creating a pull request for this issue! However, this issue hasn’t been assigned to anyone yet. Please avoid creating a PR unless you’ve been assigned to the issue. It’s important to follow this process so that everyone gets a fair chance to contribute. Kindly wait until you’re assigned before submitting a pull request.
Thanks for understanding and for your interest in contributing!
Hi @jagpreetrahi , Thanks for letting me know about the process! I apologize for jumping ahead - I wasn't aware of the assignment requirement. I've created the PR to demonstrate the implementation and get early feedback, but I completely understand the need to wait for assignment.
Should I:
- Close the PR and wait for assignment, then reopen it?
- Keep it as a draft for review but wait for assignment before marking it ready?
- Wait for maintainer guidance on next steps?
I'm happy to follow whatever process works best for the team. Thanks for your patience with a new contributor!
You don't need to close it. You just need to wait for accepting and reviewing.