Skip to content
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

Improve Docs and Spec navigation #9

Closed
benjagm opened this issue Apr 17, 2023 · 4 comments
Closed

Improve Docs and Spec navigation #9

benjagm opened this issue Apr 17, 2023 · 4 comments
Assignees

Comments

@benjagm
Copy link
Collaborator

benjagm commented Apr 17, 2023

Draft content Structure

  • Overview

    • What is JSON Schema (New)
    • Use Cases (New)
    • Roadmap (New optional)
    • Vision (New)
    • Release and Versioning (New)
    • Support and Community (New)
    • FAQ (This is new)
  • Getting Started

    • Getting started old.
      Example
    • Creating a schema (Existing getting started, but needs lots of work)
    • Examples
      • Miscellaneous examples (Needs work)
      • Modelling a file system (Needs work)
      • Other examples (Needs work)
  • Tutorials:

  • Reference:

    • JSON Schema Glossary (Outdated)
    • Learn JSON Schema (Link to https://www.learnjsonschema.com)
    • Understanding JSON Schema (Existing - The structure of the book)
  • Specification

    • Overview (New)
    • Specification (Existing but poorly structured with multiple embedded sections. Requires analysis and break it into pieces)
@benjagm
Copy link
Collaborator Author

benjagm commented Apr 19, 2023

Made some changes in the docs structure and prepared this proposal of tools prioritization:

Release 1
overview\What is JSON schema (New)
learn\Getting started (https://json-schema.org/learn/)

Release 2
learn\Creating a schema (https://json-schema.org/learn/getting-started-step-by-step.html)
Examples: Improve format and structure

Release 3
learn\Glossary (https://json-schema.org/learn/glossary.html)
overview\Roadmap
overview\Support and Community (New)

Release 4
Specification:
- Improve format and structure.
- Embed the old html format into the new format.

Release 5
overview\Use Cases (New)
overview\Vision (New)
overview\Release and Versioning (New)

@mjgutermuth
Copy link

I think this looks good. One small change I'd suggest is in the "Reference" section—I think this could be more broad than just that external link. I would suggest nesting the JSON Schema Glossary and Understanding JSON Schema in this section.

So it would look like this:

  • Reference
    • JSON Schema Glossary
    • Learn JSON Schema
    • Understanding JSON Schema

I think this would make the navigation cleaner and keep the tutorial/how-to content easy to find.

I also think "Support and Community" could be its own top-level item, and FAQ could fall under that. I think it's okay either way, though.

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 20, 2023

Thanks Melinda. I updated the taxonomy to reflect your feedback and I validated with the team both, the taxonomy and the releases so we have green light to start with Release 1.

@benjagm
Copy link
Collaborator Author

benjagm commented Jun 22, 2023

Completed until release 1. The works will continue in issue #158

@benjagm benjagm closed this as completed Jun 22, 2023
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

No branches or pull requests

2 participants