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
Learn: replace 'More ...' with 'Manual' #570
Conversation
I would actually prefer 'Nix Manual', 'NixOS Manual' and 'Nixpkgs Manual', but those documents actually have different titles. Taking one step at a time, I think changing 'More ...' to 'Manual' is a good first action :)
I think something along this lines would be nice. Maybe even "The whole Nix Manual", ... ? My point would be: When I look for documentation for a project I really want to understand what documents there are. Is it one wiki? one userguide and one reference? A loose collection of blog posts? Not knowing the overarching simple structure decreases discoverability and faith in finding information a lot. So in this case we should really communicate "For the main docs there are exactly three manuals and those useful links we have collected for you all point to one of them.“ The links are great, but I would really love something to make clear that there are this three documents. Maybe a small subtitle under the headding: “Learn Nix where "Nix manual" is a link? |
Personally, I mostly think of the manuals as reference manuals: great to look things up when you already know your way around the system, but a bit daunting if you're just getting started.
|
@raboof @maralorn Thank you for looking into this. I think you are right that there should be the manual in the name, but I would change the title - eg. Learn Nix -> Nix manual - and only change the bottom button from "More..." to "Read more...". In general the Learn section of the page is going to receive a lot of changes, especially once the format for documentation is settled (RFC #72). But I agree that what you propose would help until then. |
* add title the title "Manuals" to the whole manuals section * fix spacing since margins from search section were collapsing
I suspect that would be confusing: that gives the impression that that section is the manual, rather than just linking to it... |
@raboof I added the changes to this PR, I think it makes it makes it even more obvious now. |
Great! I hope that at the end of the whole process we have a solution for the very unfortunate situation that two of the links in the former "Learn nix" section actually point to the nixpkgs manual. |
I would actually prefer 'Nix Manual', 'NixOS Manual' and 'Nixpkgs Manual',
but those documents actually have different titles.
Taking one step at a time, I think changing 'More ...' to 'Manual' is a
good first action :)