this post was submitted on 21 Aug 2024
19 points (85.2% liked)

Nix / NixOS

1765 readers
3 users here now

Main links

Videos

founded 1 year ago
MODERATORS
 

A big part of why nix documentation is sub par. The essential tomes of nix - the nix manual, the nixos manual, the nixos options, the nixpkgs manual - each of these documents is just one long page.

They are the digital equivalent of scrolls, rather than books (codices?).

Rather than having a page number (or page link), one must unroll the scroll to the point of interest. One cannot simply flip between two points of interest. One cannot have bookmarks, or refer to page numbers. Ctrl-F is helpful, sure, but not great.

For instance, I was just looking for the documentation of the systemd.services. options. Its near the end of the colossally long scroll known as the Nixos Options Appendix. Ctrl-F on systemctl.services will get one million hits on all the myriad services nixos offers before you finally get to the relevant section. And if you do find that section (with single pixel movements of the scroll bar) and then ctrl-f, woe betide you, you're now at the top of the document and your place is lost!

top 6 comments
sorted by: hot top controversial new old
[–] paperd@lemmy.zip 12 points 2 months ago (1 children)

Why are you not using the options search at https://search.nixos.org ? Or an LSP that shows you options in your editor.

[–] pr06lefs@lemmy.ml 3 points 2 months ago (1 children)

Ha I never noticed the options search.

[–] paperd@lemmy.zip 4 points 2 months ago

well then life just substantially improved for you.

[–] Shareni@programming.dev 4 points 2 months ago (1 children)

Having everything in a single file is not really a problem.

Having extremely outdated info on topics like below is a major issue though.

One cannot have bookmarks, or refer to page numbers.

Huh?

[–] pr06lefs@lemmy.ml -3 points 2 months ago
[–] rutrum@lm.paradisus.day 1 points 2 months ago

mynixos.com also lets you navigate nixpkgs.