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.

Sign up for GitHub

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

Jump to bottom

[📝 Docs]: Implement a TOC component #1109

Open
1 task done
valeriahhdez opened this issue Nov 12, 2024 · 3 comments · May be fixed by #1127
Open
1 task done

[📝 Docs]: Implement a TOC component #1109

valeriahhdez opened this issue Nov 12, 2024 · 3 comments · May be fixed by #1127
Assignees
@techmannih
Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.

Comments

@valeriahhdez
Copy link
Contributor

valeriahhdez commented Nov 12, 2024 •
edited
Loading

What Docs changes are you proposing?

Implement a table of contents (TOC) on our documentation website that is displayed on each document on the right side of the screen. Examples of what we want to achieve:

Gatsby documentation TOC: https://www.gatsbyjs.com/docs/tutorial/getting-started/part-0/
AsyncAPI documentation TOC: https://www.asyncapi.com/docs/guides/validate

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. labels Nov 12, 2024
@techmannih
Copy link
Contributor

@DhairyaMajmudar @valeriahhdez May I work on this issue? It interests me, and I would love to contribute.

@DhairyaMajmudar
Copy link
Member

Sure! Go ahead @techmannih

@DhairyaMajmudar DhairyaMajmudar added Status: In Progress This issue is being worked on, and has someone assigned. and removed Status: Triage This is the initial status for an issue that requires triage. labels Nov 13, 2024
@techmannih
Copy link
Contributor

@DhairyaMajmudar @valeriahhdez please check this

20241117172805.mp4

@techmannih techmannih linked a pull request Nov 19, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@techmannih techmannih

Labels
📝 Documentation Indicates improvements or additions to documentation. Status: In Progress This issue is being worked on, and has someone assigned.
Projects
JSON Schema Docs
Status: In Progress
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: Implement a TOC component techmannih/website2
3 participants
@valeriahhdez @DhairyaMajmudar @techmannih