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

Inconsistent doc menu bar link order and font #1014

Open
cduck opened this issue Mar 5, 2025 · 4 comments
Open

Inconsistent doc menu bar link order and font #1014

cduck opened this issue Mar 5, 2025 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@cduck
Copy link

cduck commented Mar 5, 2025

Describe the issue
This is a UX issue when navigating the bloqade(-analog) documentation. Clicking links in the top bar (e.g. "Digital Tutorial", "Analog Tutorial") switches between bloqade docs and bloqade-analog docs with slightly different page templates.

Link to the page and section containing the issue, if applicable

https://bloqade.quera.com/latest/digital/
Image

vs.

https://queracomputing.github.io/bloqade-analog-examples/dev/
Image

Font difference:
Image
Image

Suggested content or correction, if applicable
Change the two page templates so they have the same menu bar link order, font, etc. It is alright that the logo and package name+version number change.

@cduck cduck added the documentation Improvements or additions to documentation label Mar 5, 2025
@Roger-luo
Copy link
Member

@johnzl-777 might know how to tweak this? feel free to take the issue and remove Phil if you know how to change it already.

@weinbe58
Copy link
Member

weinbe58 commented Mar 6, 2025

The difference is because Bloqade-analog has extra content that is not present in bloqade. Furthermore, it is specific only to bloqade-analog. What might make more sense is to make the color schemes different to make this more clear?

@cduck
Copy link
Author

cduck commented Mar 6, 2025

If you want to go with making the two documentation sites distinct, don't put links to the other site in the menu bar. Users expect menu bar links to navigate within a single site. Instead, at the top of the home page content, mention that the other package exists and link to it. Different menu bar colors would also be helpful.

weinbe58 pushed a commit to QuEraComputing/bloqade that referenced this issue Mar 6, 2025
This should fix part of the issue @cduck brought up here
QuEraComputing/bloqade-analog#1014 with the
fonts being slightly different. In bloqade-analog I remember setting the
font to Lato because that was what the Bloqade.jl docs used. Now I've
propagated that change to the new docs here.
@weinbe58
Copy link
Member

weinbe58 commented Mar 6, 2025

Sure I'm fine either way would anyone be opposed if I put the analog menu items in bloqade?

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

No branches or pull requests

4 participants