Skip to content

Please add sub-navigation menu in the "JSON data types" portion of the documentation #1621

@jrclaypool

Description

@jrclaypool

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 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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions