!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

438 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
4 Aug 2022
@minion3665:matrix.orgMinion3665
In reply to @rapenne-s:tchncs.de
actually using the nix repl isn't that bad, any other idea for a way to search a package?
In the wiki I'd prefer to avoid the "nix search" experimental command that has to be run near a flake.nix file
Nix search doesn't need a flake.nix file
You can run nix search nixpkgs packagename and it'll search in the nixpkgs flake
12:32:52
@rapenne-s:tchncs.deSolène Rapenne (she/her) that's pretty cool, nix --extra-experimental-features "nix-command flakes" search nixpkgs firefox 12:33:57
@minion3665:matrix.orgMinion3665
In reply to @rapenne-s:tchncs.de
that's pretty cool, nix --extra-experimental-features "nix-command flakes" search nixpkgs firefox
Yep
That'll work :)
12:34:32
@rapenne-s:tchncs.deSolène Rapenne (she/her)it's just too bad it needs to download 30MB every so often :D12:34:51
@a-kenji:matrix.orga-kenji
In reply to @rapenne-s:tchncs.de
that's pretty cool, nix --extra-experimental-features "nix-command flakes" search nixpkgs firefox
You can also search exact by nixpkgs#firefox
12:34:56
@rapenne-s:tchncs.deSolène Rapenne (she/her) it's not really faster than nix-env -aqP 12:35:52
@rapenne-s:tchncs.deSolène Rapenne (she/her)"we have 5 ways to search packges and most of them are bad" :D12:36:03
@minion3665:matrix.orgMinion3665
In reply to @rapenne-s:tchncs.de
it's not really faster than nix-env -aqP
It caches it though, so it's much faster on the next run, and it's much faster on exact matches
12:36:18
@rapenne-s:tchncs.deSolène Rapenne (she/her)indeed, if I re-run it's faster12:36:51
@rapenne-s:tchncs.deSolène Rapenne (she/her)and pick up where I aborted12:36:56
@rapenne-s:tchncs.deSolène Rapenne (she/her) now, I think https://nixos.wiki/wiki/Searching_packages is puzzling for new users, how to pick one solution over another? 12:39:01
@minion3665:matrix.orgMinion3665Hmmm, well perhaps we should at least provide a pros/cons section for each of them rather than just some, as that way it's easier to compare We could maybe even put them in a table but that's probably not necessary12:41:49
@rapenne-s:tchncs.deSolène Rapenne (she/her)I think pros / cons should be removed, and just add a sentence in the first paragraph to tell they are listed in an order of the most preferable to the least practical12:42:47
@rapenne-s:tchncs.deSolène Rapenne (she/her)using pros/cons is like having 3 wishes at a djin but you know each one has a drawback :D12:44:05
@minion3665:matrix.orgMinion3665Haha yes perhaps Although in this case it is somewhat accurate, so we at least do need to tell the reader about the drawbacks of each approach12:46:21
@fricklerhandwerk:matrix.orgfricklerhandwerkI agree (and proposed) to list pros/cons, because this is reference. Be honest about what is going on, let the readers judge on their own. Then use the tutorial layer (i.e. nix.dev) to pick the recommended way and link to the reference.12:50:07
@sandro:supersandro.deSandro 🐧just use search.nixos.org13:04:04
@pennae:matrix.eno.spacepennaehow does search.nixos.org get to the data it displays? (if it read docbook we'll have to somehow fix that for the md migration)13:12:59
@jtojnar:matrix.orgJan Tojnar pennae: it uses pypandoc 15:42:19
@jtojnar:matrix.orgJan Tojnarwell, used before the rust migration15:42:38
@jtojnar:matrix.orgJan Tojnarhttps://github.com/NixOS/nixos-search/blob/c43ed8c85f11b041db2624cc249f3f1fb68760b2/flake-info/src/data/export.rs#L31015:43:58
@pennae:matrix.eno.spacepennaeif it can natively read MD there should be no extra trouble, right?16:16:38
5 Aug 2022
@daxvena:matrix.orgKira Bruneau joined the room.01:24:48
@daxvena:matrix.orgKira Bruneau changed their display name from daxvena to Kira Bruneau.01:24:52
6 Aug 2022
@Ericson2314:matrix.orgJohn Ericson FYI to all, fricklerhandwerk's and I's reference (and some explanation docs were merged but commented out), and then I fixed up some conflicts and added more new material on my branch, opening https://github.com/NixOS/nix/pull/6877/files 03:39:40
@Ericson2314:matrix.orgJohn EricsonI am curious what people think about this split format I went with, also perhaps of commenting out the material we can do some sort of build time flag to show/hide unstable docs03:41:01
@Ericson2314:matrix.orgJohn EricsonI do want users to see the new docs, but I also on fond of just brain dumping all the information and then stepping back to edit it into the right format 03:41:52
@denna:matrix.orgolaf
In reply to @Ericson2314:matrix.org
I am curious what people think about this split format I went with, also perhaps of commenting out the material we can do some sort of build time flag to show/hide unstable docs
"split format" means 1 sencence per line? yes i think that was fricklerhandwerk suggestion before and i think it is best for collaboratively written documentation.
Commented out "braindumps" are ok i think but there should be additional information so that these comments can also be removed if they are abandoned, information like "[2022.08.01 PR in preparation]" .
15:23:39
@Ericson2314:matrix.orgJohn Ericson denna: oh the spit format I mean abstract vs concrete 15:24:04
@Ericson2314:matrix.orgJohn EricsonI introduce a sort of "platonic nix"15:24:11

Show newer messages


Back to Room ListRoom Version: 6