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

[📝 Docs]: Improve documentation's information architecture #790

Open
9 tasks done
valeriahhdez opened this issue Jul 4, 2024 · 13 comments · May be fixed by #1194
Open
9 tasks done

[📝 Docs]: Improve documentation's information architecture #790

valeriahhdez opened this issue Jul 4, 2024 · 13 comments · May be fixed by #1194
Assignees
Labels
📝 Documentation Indicates improvements or additions to documentation. GSoD Google Season of Docs Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@valeriahhdez
Copy link
Contributor

valeriahhdez commented Jul 4, 2024

What Docs changes are you proposing?

Improve the information architecture of the current documentation to align better with the documentation developer journey and organize content based on the diataxis framework. This issue is part of the Release 4 of the Documentation strategy execution [Issue #158]

To achieve this, we propose the following changes to the sidebar.

I. Content buckets

  • Rename the following content buckets:

  • Overview -> Introduction

  • Getting started -> Get started

  • Add the new content bucket:

  • Guides

These two changes should result in the following sidebar content buckets:

  • Introduction
  • Get started
  • Guides
  • Reference
  • Specification

II. Headings

  • Change the style of sidebar navigation headings from title case to sentence case.

So, for example, instead of JSON Schema Reference, it should be JSON Schema reference.

  • Rename the following documents:
  • Creating your first schema -> Create your first schema
  • JSON Schema Glossary -> JSON Schema common terms
  • Applying subschemas conditionally -> Conditional schema validation
  • Declaring a dialect -> Dialect and vocabulary declaration
  • Structuring complex schemas -> Modular JSON Schema combination
  • Schema composition -> Boolean JSON Schema combination

III. Document relocation

  • Relocate the following documents:

  • JSON schema glossary from the Reference to the Get started content bucket

  • What is a schema? from the Reference to the Get started content bucket

  • Tour of JSON Schema from the Getting started to the Guides content bucket

IV. Overview pages

  • Add an Overview page to each content bucket. The Overview should briefly describe the contents of each content bucket.

V. Reference reorganization

  • Reorganize the structure of the Reference content bucket as follows:

Overview
Learn JSON Schema
JSON Schema keywords

  1. JSON data types*
    string
    regular expressions
    numeric types
    object
    array
    boolean
    null
  2. Dialect and vocabulary declaration
  3. Value restrictions*
    Enumerated values
    Constant values
  4. Schema annotations and comments*
    Annotations
    Comments
  5. Conditional schema validation
  6. Schema composition*
    Boolean JSON Schema combination
    Modular JSON Schema combination
  7. Media: string-encoding non-JSON data
  8. Implementations*
    Common interfaces across implementations
  • For documents marked with an asterisk, include an overview describing the contents of their nested documents.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@valeriahhdez valeriahhdez added 📝 Documentation Indicates improvements or additions to documentation. Status: Triage This is the initial status for an issue that requires triage. GSoD Google Season of Docs labels Jul 4, 2024
@valeriahhdez valeriahhdez self-assigned this Jul 4, 2024
Copy link

github-actions bot commented Jul 4, 2024

Welcome to the JSON Schema Community. We are so excited you are here! Thanks a lot for reporting your first issue!! 🎉🎉 Please make sure to take a look to our contributors guide if you plan on opening a pull request.
For more details check out README.md file.

@valeriahhdez valeriahhdez removed the Status: Triage This is the initial status for an issue that requires triage. label Jul 4, 2024
@valeriahhdez valeriahhdez moved this to In Progress in JSON Schema Docs Jul 13, 2024
@valeriahhdez valeriahhdez changed the title [📝 Docs]: Documentation new structure [📝 Docs]: Documentation restructure Jul 13, 2024
@benjagm
Copy link
Collaborator

benjagm commented Jul 16, 2024

Thanks Valeria. Is this going to be all in one PR?

@benjagm benjagm added the Status: In Progress This issue is being worked on, and has someone assigned. label Jul 16, 2024
@valeriahhdez
Copy link
Contributor Author

valeriahhdez commented Jul 18, 2024

The Google spreadsheet (linked in this issue) contains changes to the information architecture and news documents that will be produced. Following our last meeting, the scope of the PR for this issue is limited to the structural changes of the new information architecture. We will create GitHub issues for the missing documents and these will be linked to this issue.

@benjagm
Copy link
Collaborator

benjagm commented Aug 13, 2024

I have some doubts regarding the proposed introduction and concepts sections.

I really like Option 1 provided in the Figma file, I don't see the benefits of option 2.

  • Introduction is a section expected to provide high-level information about the initiative, and not cover getting started guides...
  • Why having to choose between concepts and guides? For me is clear that we need a section called guides to provide the getting started guide and access to the "Tour of JSON Schema". In addition we can discuss about what to do with the Glossary, keeping it into the reference section or create a separate concepts section. At this point I suggest keeping the glossary page inside the reference as a standalone page as it is today.

@valeriahhdez
Copy link
Contributor Author

Closing this issue as the proposed changes are no longer applicable to recent documentation website improvements.

@github-project-automation github-project-automation bot moved this from Reviewing to Done in JSON Schema Docs Aug 25, 2024
@benjagm
Copy link
Collaborator

benjagm commented Aug 25, 2024

We still need to implement option 1 right?

@valeriahhdez
Copy link
Contributor Author

valeriahhdez commented Aug 25, 2024

In my opinion, most changes option 1 proposed have already been implemented in the last changes. For example, I don't think we need to add a Community section to the docs page because it already has its own page and is shown in the top menu. Maybe when we create more resources, for example to use Bowtie, we can create the Resources section. We can talk about this at our next meeting.

@benjagm benjagm reopened this Aug 28, 2024
@benjagm
Copy link
Collaborator

benjagm commented Aug 28, 2024

Hi @valeriahhdez . As we just discussed I am reopening this issue to work in the sidebar restructuring.

@benjagm benjagm moved this from Done to Reviewing in JSON Schema Docs Sep 10, 2024
@valeriahhdez valeriahhdez changed the title [📝 Docs]: Documentation restructure [📝 Docs]: Improve documentation's information architecture Sep 21, 2024
@benjagm
Copy link
Collaborator

benjagm commented Oct 27, 2024

@valeriahhdez Can you please create a new issue just with a clear explanation of what are the changes to be made in the sidebar? Please write the issue in such a way a developer with no context about the docs strategy can proceed with the changes:

For example:

  • Explaining the changes in the sidebar. Including node titles, new items, items to be removed, and changes in the hierarchy
  • Explaining the changes in the title of pages
  • Explaining the pages to be removed
  • The new intro pages are to be created, including examples.

I have been trying to find time for it but after 2 months it is being impossible.

Thanks a lot!!

@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: In Progress This issue is being worked on, and has someone assigned. labels Oct 29, 2024
@valeriahhdez valeriahhdez moved this from Reviewing to Waiting for Contributors in JSON Schema Docs Nov 6, 2024
@valeriahhdez valeriahhdez moved this from Waiting for Contributors to Todo in JSON Schema Docs Nov 6, 2024
@valeriahhdez
Copy link
Contributor Author

valeriahhdez commented Nov 7, 2024

@valeriahhdez Can you please create a new issue just with a clear explanation of what are the changes to be made in the sidebar? Please write the issue in such a way a developer with no context about the docs strategy can proceed with the changes:

For example:

  • Explaining the changes in the sidebar. Including node titles, new items, items to be removed, and changes in the hierarchy
  • Explaining the changes in the title of pages
  • Explaining the pages to be removed
  • The new intro pages are to be created, including examples.

I have been trying to find time for it but after 2 months it is being impossible.

Thanks a lot!!

Done. Let me know if anything needs further clarification.

@valeriahhdez valeriahhdez added this to the Docs Release 5 milestone Nov 7, 2024
@valeriahhdez valeriahhdez self-assigned this Nov 7, 2024
@valeriahhdez valeriahhdez removed the Status: Available No one has claimed responsibility for resolving this issue. label Nov 7, 2024
@valeriahhdez valeriahhdez moved this from Todo to In Progress in JSON Schema Docs Nov 12, 2024
@valeriahhdez valeriahhdez added the Status: In Progress This issue is being worked on, and has someone assigned. label Nov 18, 2024
@valeriahhdez valeriahhdez linked a pull request Dec 21, 2024 that will close this issue
@harshita9104
Copy link

**Sidebar Structure

  1. Rename Content Buckets**
    Overview → Introduction (to better reflect its purpose as the starting point).
    Getting Started → Quick Start (a more action-oriented and concise label).
  2. Add a New Content Bucket: "Guides"
    Relocate practical and example-based documents (currently scattered) to a new Guides section.
    Examples:
    "Tour of JSON Schema" (from Getting Started).
    "Examples" subcategory (e.g., "Miscellaneous examples," "Modeling a file system").
    II. Improved Document Grouping and Relocation
  3. Introduction
    Keep the following at the top as they are crucial for new users:
    "What is JSON Schema?"
    "Roadmap"
    "FAQ"
    Group additional general resources (e.g., "Sponsors," "Use Cases") under a Resources subheading.
  4. Quick Start
    Relocate beginner-friendly content from Reference to Quick Start to create a seamless learning path:
    "What is a schema?"
    "JSON Schema glossary"
    Rename "Creating your first schema" → "Create your first schema" for consistency.
  5. Guides (New Bucket)
    Create a focused section for practical and example-based learning:
    Relocate "Tour of JSON Schema" from Getting Started.
    Include all examples like "Miscellaneous examples," "Modeling a file system," and "Other examples."
    Add a "Common use cases" guide to showcase real-world applications.
  6. Reference
    Organize into logical subcategories:
    Keywords: Group all type-specific and generic keywords together.
    Example: "String," "Numeric types," "Boolean," "Annotations," etc.
    Schema Features: Group advanced topics like:
    "Conditional schema validation"
    "Boolean JSON Schema combination"
    "Modular JSON Schema combination"
    Implementation: Add "Common interfaces across implementations" under this heading.
    III. Style Enhancements
  7. Title Standardization
    Change all page titles to sentence case for consistency:
    Examples:
    "JSON Schema Glossary" → "JSON Schema glossary"
    "Creating your first schema" → "Create your first schema"
    "Applying subschemas conditionally" → "Conditional schema validation"
  8. Add Overview Pages
    Include an Overview page for each bucket summarizing its content.
    Example: Reference Overview briefly explains the types of keywords, schema features, and implementation details.

@harshita9104
Copy link

Hello @valeriahhdez @benjagm ,

Kindly assign me this issue!

Thank you

@valeriahhdez
Copy link
Contributor Author

valeriahhdez commented Jan 10, 2025

Hi @harshita9104,,

This issue has already been assigned and is in progress. To find issues you can claim, please check the "labels" section shows "available" and that no one has been assigned to the issue. Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Documentation Indicates improvements or additions to documentation. GSoD Google Season of Docs Status: In Progress This issue is being worked on, and has someone assigned.
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

3 participants