-
-
Notifications
You must be signed in to change notification settings - Fork 221
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
Comments
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. |
Thanks Valeria. Is this going to be all in one PR? |
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. |
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.
|
Closing this issue as the proposed changes are no longer applicable to recent documentation website improvements. |
We still need to implement option 1 right? |
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. |
Hi @valeriahhdez . As we just discussed I am reopening this issue to work in the sidebar restructuring. |
@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:
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. |
**Sidebar Structure
|
Hello @valeriahhdez @benjagm , Kindly assign me this issue! Thank you |
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. |
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:
II. Headings
So, for example, instead of JSON Schema Reference, it should be JSON Schema reference.
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
V. Reference reorganization
Overview
Learn JSON Schema
JSON Schema keywords
string
regular expressions
numeric types
object
array
boolean
null
Enumerated values
Constant values
Annotations
Comments
Boolean JSON Schema combination
Modular JSON Schema combination
Common interfaces across implementations
Code of Conduct
The text was updated successfully, but these errors were encountered: