nixos manual: segment into pages #26810
Closed
+1
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
At the moment we have one unnavigable large page. This pull request puts each chapter into a separate file. The idea solution would be to have a navigation side-bar were only first-level chapters are shown (or even a page search like sphinx). However docbook seems to be to inflexible to do that. Is there a way to get nicer looking templates like the guix manual has? https://www.gnu.org/software/guix/manual/guix.html
|
Splitting into separate pages will also help the google indexation as large pages get ranked down |
|
There was a discussion about this earlier when the switch was made to a single page #7607. |
|
Most projects offer single page and multi page for good reason as well as multiple formats (PDF/HTML) |
|
I'd definitely prefer both single-page and multi-page versions being available (as was mentioned above), as an arbitrary example: https://www.gnu.org/software/bison/manual/ |
|
Having two version would increase the build time twice. I would like avoid that, because I have to build the manual, whenever service options are changed - which is already slow. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At the moment we have one unnavigable large page.
This pull request puts each chapter into a separate file.
The idea solution would be to have a navigation side-bar were only
first-level chapters are shown (or even a page search like sphinx).
However docbook seems to be too inflexible to do that.
Is there a way to get nicer looking templates like the guix manual has?
https://www.gnu.org/software/guix/manual/guix.html
Update the template used on the website would be already enough.