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

Improve navigation in the documentation #8

Open
4 tasks
macpijan opened this issue Feb 28, 2023 · 2 comments
Open
4 tasks

Improve navigation in the documentation #8

macpijan opened this issue Feb 28, 2023 · 2 comments
Labels
P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. T: enhancement Type: enhancement. An enhancement or improvement of existing functionality. W: todo Workflow: todo. The issue is in the initial to do state.

Comments

@macpijan
Copy link
Member

macpijan commented Feb 28, 2023

The problem you're addressing (if any)

Improve navigation in the documentation (trenchboot.org site)

Describe the solution you'd like

There were some specific requests (gathered from various channels) regarding the documentation navigation that could be improved:

  • [1] Menu bar could respond to mouse-over events for faster site navigation
  • TBD
  • TBD
  • TBD

Where is the value to a user, and who might that user be?

Both new and existing users of the documentation could benefit from better site navigation
and content organization (for content organization we will have a separate issue and discussion: TBD).

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features
you've considered.

Additional context

N/A

Relevant documentation you've consulted

N/A

Related, non-duplicate issues

N/A

@macpijan macpijan added T: enhancement Type: enhancement. An enhancement or improvement of existing functionality. P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. W: todo Workflow: todo. The issue is in the initial to do state. labels Feb 28, 2023
@macpijan
Copy link
Member Author

[1] We cannot really do that with mkdocs. See: squidfunk/mkdocs-material#2198
Their reasoning also makes some sense if you think about it.

@dpsmith
Copy link
Contributor

dpsmith commented Mar 1, 2023

I think one task should be to review the existing material along with the additional information discussed on the call, and come up with a recommendation for re-organizing the site. This can be done while considering what the desired navigation is, to render what the organization should be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P: default Priority: default. Default priority for new issues, to be replaced given sufficient information. T: enhancement Type: enhancement. An enhancement or improvement of existing functionality. W: todo Workflow: todo. The issue is in the initial to do state.
Projects
None yet
Development

No branches or pull requests

2 participants