[📝 Docs]: Create Overview page for each section of the documentation

[valeriahhdez]

What Docs changes are you proposing?

Following the example of GatsbyJS documentation, we will create an Overview page for every new section of the JSON Schema documentation website, namely:

• Introduction
• The basics
• Guides
• Reference
• Specification

This Overview will recap the information each section (content bucket) contains so users know what to expect. It will also contain a Previous-Next navigation and a Submit your feedback component.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

[benjagm]

@DhairyaMajmudar do you know if there is a standard component doing this:

[DhairyaMajmudar]

Not a specified component but this much line of codes does the kind of same thing

https://github.com/json-schema-org/website/blob/main/components/Sidebar.tsx#L370-L428

[fee-sah-yor]

I would like to work on this @json-schema-org/docs-team @valeriahhdez

[harshita9104]

Hello @valeriahhdez , @benjagm @DhairyaMajmudar ,

I would like to work on this issue, Kindly assign me for this issue!

I have experience working as a technical writer at Atlan, and i am eagerly looking forward to contribute to the documentation.

I propose introducing structured Overview pages for each major section of the website. Drawing inspiration from the exemplary GatsbyJS documentation, this initiative aims to empower users with a clear roadmap and an enhanced navigation experience.

Proposed Enhancements Crafting Overview Pages for Key Sections:

For sections including Introduction, The Basics, Guides, Reference, and Specification, I propose adding dedicated Overview pages that concisely: Highlight the purpose and key takeaways of each section. Provide a quick reference to subtopics, ensuring users know exactly what to expect. Integrating Seamless Navigation:

Implement Previous-Next navigation links at the bottom of each Overview page to streamline transitions between sections, reducing user frustration and promoting logical flow. Introducing Feedback Mechanism:

Add a Submit your feedback component to every Overview page, enabling users to share suggestions, report inaccuracies, and contribute to iterative documentation improvements. Modernizing Structure with Visual Cues:

Enhance these Overview pages with clean layouts, intuitive headings, and subtle design elements that improve readability and align with modern documentation standards.

Kindly assign me this issue!

Thank you!!

[valeriahhdez]

Hi @harshita9104,

I appreciate your interest in this issue. I am putting this issue on hold because the description of each content bucket is with an Overview page is addressed in PR #1194 which still needs revision by the team. However, there are some elements of this issue I didn't address that you can contribute to if you want:

• the Next-Previous component
• submit your feedback component. Checkout issue #805 for the requirements

Thank you for understanding and I look forward to your contributions

PS I have updated this issue to convey the needs of the project

[valeriahhdez]

Closed, as this issues was addressed in PR #1194