Change documentation structure #802
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.
valeriahhdez
added
📝 Documentation
|
Hello @benjagm, @DhairyaMajmudar, and @kwennB This PR is ready for review |
|
We have to also change the of resources and contributors tabs since currently they are same as concepts tab. |
components/Sidebar.tsx
Outdated
| setOpen={setOpen} | ||
| /> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| {/* Reference */} |
There was a problem hiding this comment.
I noticed no changes to the Reference section; I understood that this section needed a more intensive overhauling, i.e., by implementing Diataxis.
|
Hi Valeria. I agree with the content buckets suggested in #790 but to implement it we don't necessarily need to move all the content to new folders. In my opinion, the first thing to do is to rename the sections in the sidebar and place the content in the right place. It is not mandatory to have the URLs to match the content bucket. Moving folders will require to create redirects for all the pages. Basically changing only the Sidebar component. In addition, You added to this PR some contribution guides that are not part of the scope of issue #790 . That will require a separate issue. In addition, we already have a contributing file as @gregsdennis said. Why not adding the content there and use a symlink to show it as a page (As we do with sponsors and the code of conduct md files. I can help to implement this ) |
benjagm
added
the
Status: In Progress
What kind of change does this PR introduce?
It changes the structure of the documentation website.
Issue Number:
Screenshots/videos: TODO
If relevant, did you update the documentation?
Summary
The changes introduced by this PR aim at improving the user experience with the documentation. We're organizing the information into content buckets that better align the reader's needs and learning journey.
Does this PR introduce a breaking change?
No, it doesn't