!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

421 Members
Discussion about documentation improvements around the Nix ecosystem87 Servers

Load older messages


SenderMessageTime
2 Mar 2024
@dmills27:matrix.orgDominic Mills
In reply to @jade_:matrix.org
it has bad search and is not designed as a docs website, so you have a bunch of extraneous stuff around that's not relevant to the docs. their markdown renderer isn't bad but eh we can have nicer things than GitHub
This actually might make a decent Google Season of Docs proposal 😃. I remember seeing this Summer of Code project for automating Puppeteer's docs (https://gist.github.com/tasneemkoushar/941128bc0d04f095fa01a5334617c65b) which incorporated search features using algolia. Nix doesn't have nice enough tooling to make this feasible, since to the best of my knowledge, the only thing we have to automating the generation of docs is nixdoc (https://github.com/nix-community/nixdoc) which is nice but leaves a lot to be desired.
20:13:22
@jade_:matrix.org@jade_:matrix.orgnope theres another new one20:13:43
@jade_:matrix.org@jade_:matrix.orgafter the rfc20:13:47
@jade_:matrix.org@jade_:matrix.orgi think it is now under nix-community20:13:53
3 Mar 2024
@lurkki:pikaviestin.fiLurkkiclipboard.png
Download clipboard.png
14:03:53
@lurkki:pikaviestin.fiLurkkiHow can I render the docs into HTML locally?14:04:03
@lurkki:pikaviestin.fiLurkki
In reply to @lurkki:pikaviestin.fi
How can I render the docs into HTML locally?
Ah, noticed it's in a separate package
14:11:56
@lurkki:pikaviestin.fiLurkki* Ah, noticed the renderer is in a separate package14:12:13
5 Mar 2024
@danielsidhion:nixos.devdanielsidhion Conflicted about something: in its current state, snapTools.makeSnap produces broken snaps. With a patch, it works only for static binaries, but I haven't figured out a way to make it work in more general cases, and the spec leads me to believe that making it work will be very hard. Do I put in the nixpkgs manual that makeSnap is broken as-is, but still document the function normally? Do I just remove it from the manual entirely and proceed with removing the code for makeSnap? Looks like it's been broken since late 2020 according to this issue: https://github.com/NixOS/nixpkgs/issues/100618 01:42:12
@infinisil:matrix.orginfinisil danielsidhion: I'd be in favor of removing, or rather replacing with an error saying why it was removed. That error could also link to that issue 03:01:18
@philiptaron:matrix.orgPhilip Taron (UTC-8) Is there an existing issue or proposal for making :doc (from nix repl) work on more than just builtins? 18:35:23
@jade_:matrix.org@jade_:matrix.org
In reply to @philiptaron:matrix.org
Is there an existing issue or proposal for making :doc (from nix repl) work on more than just builtins?
hahahaha lmao
18:47:27
@jade_:matrix.org@jade_:matrix.org(this is why the nix-doc plugin was created in 2021)18:47:40
@philiptaron:matrix.orgPhilip Taron (UTC-8)How much ugly history is there?18:48:11
@jade_:matrix.org@jade_:matrix.orghttps://github.com/NixOS/nix/issues/390418:48:29
@jade_:matrix.org@jade_:matrix.org

I will say, my implementation cannot die to the bikeshed because it cannot in good conscience ever be merged ;-)

18:49:02
@jade_:matrix.org@jade_:matrix.org(and indeed it has been working perfectly for the past three and a half years)18:49:38
@qyriad:katesiria.orgQyriad(See also: https://github.com/NixOS/nix/pull/9054)18:49:42
@jade_:matrix.org@jade_:matrix.org^^^ yes18:49:52
@philiptaron:matrix.orgPhilip Taron (UTC-8)Thank you for the links!19:00:43
6 Mar 2024
@sammy:cherrykitten.dev@sammy:cherrykitten.dev joined the room.19:04:10
@ktemkin:katesiria.org@ktemkin:katesiria.org joined the room.22:25:14
7 Mar 2024
@infinisil:matrix.orginfinisil danielsidhion: Are you still there? 15:57:20
@danielsidhion:nixos.devdanielsidhionBrief connection issues16:00:36
@efx:matrix.orgEli Flanagan I have a desire to document a common obstacle I face using nix installed on alternate GNU/Linux distributions. It is practical advice on adding ~/.nix-profile/bin to $PATH using .bashrc.
Is there an ideal place to put this kind of documentation?
17:20:38
@danielsidhion:nixos.devdanielsidhionI think that is already documented in the nix manual: https://nixos.org/manual/nix/stable/installation/env-variables It's not particularly discoverable though. What resources did you read/search for when trying to install nix on your distribution?17:25:21
@infinisil:matrix.orginfinisil Eli Flanagan: That should be done by the Nix installer (see here). If it's not done it sounds like something went wrong 17:34:18
@efx:matrix.orgEli Flanagan
In reply to @danielsidhion:nixos.dev
I think that is already documented in the nix manual: https://nixos.org/manual/nix/stable/installation/env-variables
It's not particularly discoverable though. What resources did you read/search for when trying to install nix on your distribution?
ooh, thanks for that link! I had not seen that before. My immediate context was trying nix copy to ssh://myhost myclosure. I searched discourse, then started digging in the stable reference manual.
17:36:12
@efx:matrix.orgEli Flanagan
In reply to @infinisil:matrix.org
Eli Flanagan: That should be done by the Nix installer (see here). If it's not done it sounds like something went wrong
true, and the installer placed the appropriate line in the users ~/.bash_profile. Some context may clarify. I have a single user Nix installation on vanilla AmazonLinux2023 servers.
17:37:06
@jade_:matrix.org@jade_:matrix.orgoh hmmm i wonder if this is an old bug of mine 17:37:36

Show newer messages


Back to Room ListRoom Version: 6