json-schema-org / json-schema-org/website
Documentation site not as helpful as it once was
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 169
- Forks
- 484
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 6
Description
I have been away from work that requires understanding JSON Schema(s) for a couple of years, but just encountered an item where we decided to utilize it. As part of reviewing it, I wanted to reference the documentation and learned that there is a "new" JSON Schema documentation site, and I do not find it very helpful at all.
https://web.archive.org/web/20221224225320/https://json-schema.org/understanding-json-schema/ has been my go to for reviewing schema concepts, and I cannot find the equivalent on the new site. In fact, the old overall docs are still MUCH easier to navigate in my opinion. I really cannot figure out how to even find relevant information on the new site.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the archived Understanding JSON Schema and Learn pages linked in the issue with the current JSON Schema documentation site, starting by tracing how users find equivalent topics today. Identify the navigation or content gaps to address, then confirm that the revised site makes the relevant schema concepts easier to locate and use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100