TrenchBoot / trenchboot-issues

This repository is to centralize issues and development progress tracking for the TrenchBoot project.
3 stars 1 forks source link

Improve navigation in the documentation #8

Open macpijan opened 1 year ago

macpijan commented 1 year ago

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:

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 commented 1 year ago

[1] We cannot really do that with mkdocs. See: https://github.com/squidfunk/mkdocs-material/discussions/2198?sort=top#discussioncomment-272434 Their reasoning also makes some sense if you think about it.

dpsmith commented 1 year ago

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.