nlohmann / json

JSON for Modern C++
https://json.nlohmann.me
MIT License
42.97k stars 6.72k forks source link

The website's hamburger menu opens to the home menu #3942

Open milo-kerr-tfs opened 1 year ago

milo-kerr-tfs commented 1 year ago

Description

The hamburger menu opening to the home menu instead of the main menu is really confusing and makes it difficult to find the link to the API documentation.

Reproduction steps

  1. visit https://json.nlohmann.me/
  2. press the hamburger menu
  3. the home menu appears, giving the appearance that the main menu to the other parts of the site doesn't exist.

Expected vs. actual results

When visiting the main page of the site, the hamburger menu should open to the main menu. As a user, it appears the home menu is the only collection of links on the site. Very frustrating when trying to find the API documentation.

Minimal code example

No response

Error messages

No response

Compiler and operating system

Firefox

Library version

N/A

Validation

nlohmann commented 1 year ago

I am not sure whether this is easily fixable as we are using mkdocs.

schuylermartin45 commented 1 year ago

Sounds like this is the bug and patched in v9.0.12 of mkdocs-material.

From the requirements.txt file in mkdocs/, it looks like version mkdocs-material==8.5.11 is in use. So maybe it's as simple as pulling in a newer version of mkdocs-material?

schuylermartin45 commented 1 year ago

^ Big big caveat that I'm currently unable to get the docs to serve locally on any branch (details in the PR), but I want to make sure I got something up for others to work off of.

schuylermartin45 commented 1 year ago

The good news is I was able to figure out the issue with the documentation engine.

I needed to brew install plantuml/sudo apt install plantuml. I will raise an issue to address that confusion in the future.

The bad news is that upgrading to the latest mkdocs-material and associated dependencies does not appear to fix the issue outlined in their fixed issue. I suppose we could try targeting the version mentioned in the bug fix instead of using the latest build (in case of a regression).