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]: Create Overview page for each section of the documentation #803

Open
1 task done
valeriahhdez opened this issue Jul 18, 2024 · 2 comments
Open
1 task done
Labels
📝 Documentation Indicates improvements or additions to documentation. GSoD Google Season of Docs

Comments

@valeriahhdez
Copy link

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
  • Concepts
  • Reference
  • Specification
  • Contributing
  • Resources

This Overview will recap the information each section (content bucket) contains so users know what to expect.

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 and removed Status: Triage This is the initial status for an issue that requires triage. labels Jul 18, 2024
@benjagm
Copy link
Collaborator

benjagm commented Jul 22, 2024

@DhairyaMajmudar do you know if there is a standard component doing this:
Screenshot 2024-07-22 at 23 40 37

@DhairyaMajmudar
Copy link
Member

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

@benjagm benjagm assigned benjagm and unassigned benjagm Aug 27, 2024
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
Projects
Status: Todo
Development

No branches or pull requests

3 participants