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

Collapsing folders feature on nav bar is problematic #3531

Open
apinnick opened this issue Dec 17, 2024 · 6 comments
Open

Collapsing folders feature on nav bar is problematic #3531

apinnick opened this issue Dec 17, 2024 · 6 comments

Comments

@apinnick
Copy link
Contributor

Can we please reverse the new nav bar feature where folders that are not in focus are collapsed? This feature makes it impossible for me to view the contents of 2 folders simultaneously or to review the overall structure of the document.

If there is a strong preference for collapsing folders, could we set up an alternative view that exposes the entire TOC?

@maximiliankolb
Copy link
Contributor

Not sure if bad advice or a neat workaround: If you use a container to build foreman-documentation, then you won't see any navigation at the top or any JS applied to the navigation on the side. 🙃 (it works for me)

On a more serious note: If it's solely about reviewing content, then maybe we can come up with a small hack or make target that builds the navigation? Or maybe a button (for everyone) that expands the complete nav bar?

@apinnick
Copy link
Contributor Author

This is mainly for reviewing PRs, especially ones that involve major content restructuring.

However, the feature is just plain irritating. I want the choice to view more than one folder at the same time, without a script deciding what I can view. I don't want to see a navigation build unless it includes the content. An optional view with the complete nav bar would be OK.

Was this feature implemented after discussion and testing? I recall that Lena created a PR but I do not recall whether it was to resolve an issue.

@maximiliankolb
Copy link
Contributor

However, the feature is just plain irritating.

I like it!

Was this feature implemented after discussion and testing? I recall that Lena created a PR but I do not recall whether it was to resolve an issue.

It was tested and reviewed, similar to every other upstream PR.

I don't want to see a navigation build unless it includes the content. An optional view with the complete nav bar would be OK.
This is mainly for reviewing PRs, especially ones that involve major content restructuring.

I see three options:

  • Revert the PR and go back to the old UI/UX
  • Create something that is for reviewing only (curl --silent --show-error https://docs.theforeman.org/nightly/Provisioning_Hosts/index-katello.html | rg "^<h[1-9]")
  • Make the tocify JS optional so that readers can enable/disable it themselves in the navigation.

@apinnick
Copy link
Contributor Author

Make the tocify JS optional so that readers can enable/disable it themselves in the navigation.

This would be awesome. Would it be hard to implement?

@maximiliankolb
Copy link
Contributor

I have no idea but I will ask around. This might take a while due to holidays etc.

@maximiliankolb
Copy link
Contributor

@apinnick I spoke with a colleague about this. I had something like the dark mode toggle on https://docusaurus.io/ in my mind. It is possible but you might need to set a cookie (unverified!). Also, it will require some engineering to make the JS conditional based on user input.

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

No branches or pull requests

2 participants