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

[website] inconsistent ordering on Explanations on Menu vs ToC #3322

Closed
mwachs5 opened this issue Jun 2, 2023 · 0 comments · Fixed by #3346
Closed

[website] inconsistent ordering on Explanations on Menu vs ToC #3322

mwachs5 opened this issue Jun 2, 2023 · 0 comments · Fixed by #3346
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!

Comments

@mwachs5
Copy link
Contributor

mwachs5 commented Jun 2, 2023

Type of issue: Bug Report

Please provide the steps to reproduce the problem:

Go to the website, click chisel3 link: https://www.chisel-lang.org/chisel3/docs/introduction.html

Click the "explanations" link either on that page or on the sidebar.

What is the current behavior?

Note that that page has a ToC of the sections that encourages users to read them in that order. It has gotten out of sync with the sidebar, which is not in a consistent or sensical order (e.g. Connectable article is #3 which is way too early on the sidebar, but probably too late in the ToC version).

Also there are two sections on the sidebar Intrinsic and Intrinsic Modules with the same content.

There may be other mismatches / things that aren't in a sensical order for the reader.

Source for the sidebar is here: https://github.com/chipsalliance/chisel/blob/main/website/docs/src/main/resources/microsite/data/menu.yml

Source for the ToC is here: https://github.com/chipsalliance/chisel/blob/main/docs/src/explanations/explanations.md

What is the expected behavior?

The Sidebar should be in same order as ToC, and both should be ordered by a "read things in this order".

Please tell us about your environment:

Google Chrome

Other Information

What is the use case for changing the behavior?

@mwachs5 mwachs5 added the good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved! label Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue An issue whose fix is simple. Perfect for a new developer wanting to get involved!
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant