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

Add Next and Back Navigation Buttons to the Documentation #2864

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

Conversation

corwinjoy
Copy link
Contributor

@corwinjoy corwinjoy commented May 13, 2024

Add navigation buttons to the documentation as per the proposal here: #2852

Comments:

  1. I was able to get this to work pretty well but there were a couple limitations.
    a. The Sitemap appears twice, once at the top level and once at the beginning of the documentation. I had to pick one to get a single navigation order so I chose the Sitemap position in the left menu.
    b. I did not include navigation for the demo page since I think that makes no sense.

  2. I made the buttons as pretty as I know how, but I'm not all that great at graphic design. The buttons are a class in the css file so I welcome suggestions there.

  3. It might make sense to have navigation buttons at the top of the page as well, but I am not as sure how, or if, I should do that.

Thanks in advance for taking a look! I do think this does help to improve the docs.

@corwinjoy
Copy link
Contributor Author

corwinjoy commented May 13, 2024

I did also run the linter as suggested by the contribution guide. I didn't see any errors from this addition, but it did come back pretty dirty / suggesting changes for the existing code so I'm not sure what to make of that. (Edit: Regex errors already seem to be fixed and I have fixed the reported grammar errors in a separate PR.)

{
"page": "Overview",
"url": "index"
},
Copy link
Contributor Author

@corwinjoy corwinjoy May 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned, this page is pointed to by both the the docs and the sitemap link. I had to choose a single location in order to get a unique navigation order.

@szarnyasg
Copy link
Collaborator

Hi, thanks for this PR! I passed it along to our design team for feedback. Will let you know the outcome.

@corwinjoy
Copy link
Contributor Author

@szarnyasg Very cool! Does the design team have any questions or feedback? I think this would be a helpful feature for navigating the web documentation.

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.

None yet

2 participants