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

Proposal: Better docs #429

Open
nickbar01234 opened this issue Jan 22, 2025 · 0 comments
Open

Proposal: Better docs #429

nickbar01234 opened this issue Jan 22, 2025 · 0 comments

Comments

@nickbar01234
Copy link

nickbar01234 commented Jan 22, 2025

Problem

Hi maintainer, I noticed while referencing the public docs that it's quite hard to navigate. While the current theme is nice and minimal, I think it doesn't quite offer us (the users) the necessary convenient. For example, we don't have a navigation bar.

Proposal

Two solutions I can think of.

  1. [Preferred] Update to a modern theme with all the necessities built in (just-the-docs seems quite nice)
  2. If you agree with the necessity for a navigation bar (and other things), we can probably find a work around and implement it with the current theme.

Let me know what you think.

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

1 participant