Skip to content

UJS arrays reference needs content work #231

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
gregsdennis opened this issue Nov 19, 2023 · 8 comments · Fixed by #651
Closed

UJS arrays reference needs content work #231

gregsdennis opened this issue Nov 19, 2023 · 8 comments · Fixed by #651
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@gregsdennis
Copy link
Member

gregsdennis commented Nov 19, 2023

https://json-schema.org/understanding-json-schema/reference/array

There's a lot that's confusing here. A lot of the examples use prefixItems when talking about pre-2020-12 versions.

Related to https://github.com/orgs/json-schema-org/discussions/535

@jdesrosiers
Copy link
Member

Can you be more specific? There aren't any examples using pre-2020-12 versions. UJS covers only the latest release, but also includes "Draft Specific" boxes where necessary to give information about how previous versions were different.

@gregsdennis
Copy link
Member Author

Looks like it might be a rendering issue.

Here's the intended format of the draft-specific info. It's isolated to the yellow block.

image

Here's later down the page. The container doesn't render, and it looks like the code below it is related.

image


UJS covers only the latest release

There is a blurb at the beginning of the "book." But since it's only online now and people can navigate directly to where they want to go, it's likely that a reader will never see it (as the person to started the discussion probably did).

@jdesrosiers
Copy link
Member

Agreed. That draft-specific box should be rendered like the other one. It should be more clear that it's an aside and not part of the main content.

@benjagm benjagm added the 📝 Documentation Indicates improvements or additions to documentation. label Nov 22, 2023
@benjagm benjagm moved this to Todo in JSON Schema Docs Nov 23, 2023
@benjagm benjagm added good first issue Good for newcomers Status: Available No one has claimed responsibility for resolving this issue. labels Feb 20, 2024
@srini047
Copy link
Contributor

@benjagm I would like to take up this issue.
So to my understanding, this Draft-specific info of the latter image needs to be formatted to display like the actual one referenced.

@benjagm
Copy link
Collaborator

benjagm commented Feb 22, 2024

I would like to take up this issue.

You are right. A pointer for you: Please check TabsGroup component inside components/StyledMarkdown.tsx.

@benjagm benjagm added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Available No one has claimed responsibility for resolving this issue. labels Feb 22, 2024
@benjagm benjagm moved this from Todo to In Progress in JSON Schema Docs Feb 22, 2024
@lalitkumawat1m
Copy link
Contributor

Hey @benjagm ,
Is this issue still open or can I take this?

@benjagm
Copy link
Collaborator

benjagm commented Apr 11, 2024

@srini047 are you still working on this?

@srini047
Copy link
Contributor

@srini047 are you still working on this?

Yes @benjagm , will make PR soon.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. good first issue Good for newcomers Status: In Progress This issue is being worked on, and has someone assigned.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants