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

fix: Implement a TOC component #1127

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

techmannih
Copy link
Contributor

What kind of change does this PR introduce?
This PR introduces a new Table of Contents (TOC) component to improve the navigation within long documentation pages. It parses the markdown content and dynamically generates a list of links to the headers, making it easier for users to navigate the page

Issue Number:

@techmannih techmannih requested a review from a team as a code owner November 19, 2024 11:51
@techmannih
Copy link
Contributor Author

techmannih commented Nov 20, 2024

@valeriahhdez @Kalevins
We need to discuss the documentation sections for the following endpoints:

/implementers/interfaces
/understanding-json-schema/reference/annotations
/understanding-json-schema/reference/comments
/understanding-json-schema/reference/enum
/understanding-json-schema/reference/const
/understanding-json-schema/reference/null
/understanding-json-schema/reference/boolean
/understanding-json-schema/reference/type

Currently, there is no heading for these sections in the docs. Also, for the Table of Contents (TOC), can we include the titles of the page sections, or is there a better way to organize them? Let’s discuss how we can improve the structure and add appropriate headings and TOC elements.

@techmannih
Copy link
Contributor Author

@valeriahhdez Please review this PR

@valeriahhdez
Copy link
Contributor

Hi @techmannih,

I'm not sure I understand what you mean by "there's no heading for these sections in the docs". Can you please expand on that?

@techmannih
Copy link
Contributor Author

@valeriahhdez I mean, for these points, there is no heading and content available that can be added in TOC. In toc, we are adding heading

@valeriahhdez
Copy link
Contributor

Summary of our Slack discussion:

  • The endpoints' content lacks headings and therefore the TOC is empty when generated.
  • The documentation team will edit this documentation and reorganize its content by headings. This will improve the readers' experience by making it easier to scan and find information.
  • Editing the documentation is outside the scope of this PR, so we will create a separate issue for the task.

@valeriahhdez
Copy link
Contributor

Hi @DhairyaMajmudar, can you please help us review this PR?

@DhairyaMajmudar DhairyaMajmudar self-requested a review December 13, 2024 01:17
@DhairyaMajmudar
Copy link
Member

@techmannih pls. fix the failing ci

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📝 Docs]: Implement a TOC component
3 participants