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

Implement the new website docs structure #22

Closed
benjagm opened this issue Apr 18, 2023 · 11 comments · Fixed by #31
Closed

Implement the new website docs structure #22

benjagm opened this issue Apr 18, 2023 · 11 comments · Fixed by #31
Assignees

Comments

@benjagm
Copy link
Collaborator

benjagm commented Apr 18, 2023

This is the new content taxonomy agreed in #9

  • Overview

    • What is JSON Schema? (New - Create an empty md page)
  • Getting Started (Create an empty md page)

  • Reference:

    • JSON Schema Glossary
    • Learn JSON Schema (Link to https://www.learnjsonschema.com)
    • Understanding JSON Schema (Existing - The structure of the book)
      • Conventions used in this book
      • What is a schema?
      • The basics
        • Hello, World!
        • The type keyword
        • Declaring a JSON Schema
        • Declaring a unique identifier
      • JSON Schema Reference
        • Type-specific keywords
        • string
        • Regular Expressions
        • Numeric types
        • object
        • array
        • boolean
        • null
        • Generic keywords
        • Media: string-encoding non-JSON data
        • Schema Composition
        • Applying Subschemas Conditionally
        • Declaring a Dialect
      • Structuring a complex schema
        • Schema Identification
        • Base URI
        • $ref
        • $defs
        • Recursion
        • Extending Recursive Schemas
        • Bundling
  • Specification (Existing but poorly structured with multiple embedded sections. Requires analysis and break it into pieces)

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 20, 2023

This issue is ready for implement @OlliesWorld

@OlliesWorld
Copy link
Contributor

I can get started on this next week!

@OlliesWorld
Copy link
Contributor

@benjagm question about which are just titles and which are pages. Are Overview, Getting Started and Reference the only titles? Every thing else are links to pages?

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 24, 2023

Overview and Reference are just Titles, but Getting Started will be the title of a main section and with new page associated if that is possible.

@OlliesWorld
Copy link
Contributor

Ok I can add a component for a title that is a link.
What about Examples, The basics, JSON Schema Reference, Structuring a complex schema are these just titles?
The reason I am asking is there is spacing around titles that makes it a little weird, see screenshot.

Image

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 24, 2023

Those are just titles and the space is not required.

FYI in the screenshot The Basics, JSON Schema Reference and Structuring a Complex Schema should be at same level than What is a Schema.... and if possible not using bold letters. I'll prefer to keep bold for top level sections.

@OlliesWorld
Copy link
Contributor

ok maybe have a subtitle component with less space around it. Keep the bold color, correct?

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 24, 2023

Let's keep bold only for top level section. For Titles of subsections we can try:
a. Not using bold
b. Use bold but with a less intense font colour.

You can try and decide for what option works best.

@OlliesWorld
Copy link
Contributor

@benjagm Here are 2 screenshots for the subtitles. Let me know what yo think. I can push up if you want to see it full browser.
first -I kept the bold and decrease the color by 200> bold-text-slate-700

Image

Second - took off bold and left the text color the same

Image

@benjagm
Copy link
Collaborator Author

benjagm commented Apr 26, 2023

I like the second option.

@OlliesWorld OlliesWorld linked a pull request Apr 26, 2023 that will close this issue
@benjagm
Copy link
Collaborator Author

benjagm commented Apr 26, 2023

This is the PR: #31

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

Successfully merging a pull request may close this issue.

2 participants