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

Docs: Switch theme to enable page navigation and search #2502

Closed
MattHag opened this issue May 27, 2024 · 3 comments · Fixed by #2527
Closed

Docs: Switch theme to enable page navigation and search #2502

MattHag opened this issue May 27, 2024 · 3 comments · Fixed by #2527

Comments

@MattHag
Copy link
Collaborator

MattHag commented May 27, 2024

The documentation on GitHub Pages lacks an overview and navigation structure to find all pages. Furthermore, it is common to have a search.

Solution

Switch to a common theme with left sidebar for navigation and built-in search like just-the-docs. This theme even supports mermaid for the diagrams.

With that change, the jekyll folder should be unified and merged into docs.

@MattHag MattHag changed the title Docs: Introduce overview of all pages Docs: Introduce navigation with all documentation pages May 27, 2024
@MattHag MattHag changed the title Docs: Introduce navigation with all documentation pages Docs: Switch theme to enable a page navigation and search May 27, 2024
@MattHag MattHag changed the title Docs: Switch theme to enable a page navigation and search Docs: Switch theme to enable page navigation and search May 27, 2024
@MattHag
Copy link
Collaborator Author

MattHag commented May 31, 2024

@pfps That's something for you, as the doc creation is not public

@MattHag
Copy link
Collaborator Author

MattHag commented Jun 6, 2024

#2516 is an example, that's solveable with enhanced and easy to navigate documentation.

@MattHag
Copy link
Collaborator Author

MattHag commented Jun 8, 2024

MKDocs seems ro be better, when adding developer docs as well
https://github.com/squidfunk/mkdocs-material/tree/master

This seems more in line with #2503.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant