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

nixos manuals are way too big and hard to navigate #92272

Closed
jnoortheen opened this issue Jul 4, 2020 · 5 comments
Closed

nixos manuals are way too big and hard to navigate #92272

jnoortheen opened this issue Jul 4, 2020 · 5 comments
Labels
0.kind: bug Something is broken

Comments

@jnoortheen
Copy link

Describe the bug
As of now the manual pages are big and takes too long to load. Also it is hard to navigate between titles.
The initial page load take too long https://nixos.org/nixos/manual/index.html . If I hit any of the title's that too makes the page load again https://nixos.org/nixos/manual/index.html#sec-writing-documentation .

It is just a small usability thing. But it makes look like that nixOS coming from last era.

Can we adopt something like this ? on most of the doc frameworks, this is just a config change. But I haven't used docbook and want to help in anyway I can.

@jnoortheen jnoortheen added the 0.kind: bug Something is broken label Jul 4, 2020
@jnoortheen jnoortheen changed the title nix manual and nixos manula are way too big and hard to navigate nixos manuals are way too big and hard to navigate Jul 4, 2020
@jnoortheen
Copy link
Author

Here are two theme which I think would be helpful if it is to use hugo as the docs generator

https://example.docsy.dev/docs/tasks/beds/
https://themes.gohugo.io//theme/hugo-book/

@jtojnar
Copy link
Member

jtojnar commented Jul 4, 2020

This is a known issue and it is being worked on, see NixOS/rfcs#64 and #68020

@jnoortheen
Copy link
Author

Oh I see. It is sad that there doesn't seems to be any decision made yet. The RFCs are rejected.

@jtojnar
Copy link
Member

jtojnar commented Jul 4, 2020

We (the RFC shepherds) have decided to focus on a more focused RFC (currently being prepared) instead.

@jnoortheen
Copy link
Author

OK. I am closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
0.kind: bug Something is broken
Projects
None yet
Development

No branches or pull requests

2 participants