!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

395 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
24 Oct 2024
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @ronef:matrix.org
Hey, every NixCon I do a collaborative "State of the Union" where folks from various efforts/teams come share a slide for two minutes and a call to action. Thought to check if someone from the docs team might be interested and is coming to NixCon!
Johannes Kirschbauer @hsjobeki: do you want to add something about doc comments last minute?
08:39:56
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org insteadUh i didnt plan. But it would be so nice to call for help with the Last Bits of migration 08:41:00
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead @ronef:matrix.org: i am going on train now. A little Community effort to finish with doc-comments migration would be so nice. Its been a huge milestone and is actually very easy. But a lot of handwork is required. I could make a little guide for how to do it with the hope that some people are willing to jump in for the missing mile 08:44:07
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @brunbjerg:matrix.org
It seems that I need to study the documentation more before, I can contribute.
I will donate to the Nix Documentation team as a first step.
Also, I have been reading through the dev.nix and of the parts that I have read I think does a really good job!
I may have visited nix.dev before, if I had it was not clear to me that nix.dev serves as an entrypoint for all the other documentation sources.
Also, the fact that when you go to nixos.org and from the main page are not 100% certain where the main documentation site is, seems to me a pressing point (what do you guys think?). Ideally we should be directing as much trafic through nix.dev as possible when people are looking for documentation?

Thanks a lot for the financial support!!

And adding clearer pointers to documentation from nixos.org would certainly help

08:55:45
@ronef:matrix.orgronef Johannes Kirschbauer @hsjobeki: see if there's anything you'd want to add here about it
Are you going to be around at NixCon?
https://docs.google.com/presentation/d/1G9Rc6cxWKgMM1q0DtgwyWUauBZ0vBLhAiV3M5ZuvEyo/edit#slide=id.g23efee59dda_0_212
09:05:12
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead
In reply to @ronef:matrix.org
Johannes Kirschbauer @hsjobeki: see if there's anything you'd want to add here about it
Are you going to be around at NixCon?
https://docs.google.com/presentation/d/1G9Rc6cxWKgMM1q0DtgwyWUauBZ0vBLhAiV3M5ZuvEyo/edit#slide=id.g23efee59dda_0_212
Yes i will be there starting from today 6pm
09:21:40
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead @fricklerhandwerk:matrix.org: do we want to add nix-documentation team Slide? There was quite some stuff Happening this year. Stuff for reference documentation - Jan noogle 2024 released - doc-comments now implemented in nix-repl (roberth ported from lix i think) - Infra / Domain Changed (you did this i think with roberth) - multi Version nix Manual - nix.dev (i dont know what Majors happened there) ... Maybe we should sit down and Filter Out the important stuff? 09:26:55
@ronef:matrix.orgronefHappy for you to have a slide and take ~2 minutes for doc team updates and call to actions09:28:18
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host
@fricklerhandwerk:matrix.org: do we want to add nix-documentation team Slide? There was quite some stuff Happening this year. Stuff for reference documentation - Jan noogle 2024 released - doc-comments now implemented in nix-repl (roberth ported from lix i think) - Infra / Domain Changed (you did this i think with roberth) - multi Version nix Manual - nix.dev (i dont know what Majors happened there) ... Maybe we should sit down and Filter Out the important stuff?
Tbh IMO this year was rather quiet. We did a bunch of things for sure, but nothing qualitatively different from last year except doc comments landing. Maybe versioned Nix manuals, but that’s a lot less important for the NixCon audience than doc comments I think
09:30:38
25 Oct 2024
@aniketd:matrix.organiketd left the room.06:21:05
@h7x4:nani.wtfh7x4

Just a quick question about the lib type signatures - is it an active decision we have made not to note subtypes for attrsets? Or has it just become this way?

# Current state for lists
map :: (a -> b) -> [a] -> [b]

# Current state for attrs
mapAttrs :: (String -> Any -> Any) -> AttrSet -> AttrSet

# I'd like something like this
mapAttrs :: (String -> a -> b) -> { * :: a } -> { * :: b }

# Or alternatively just
mapAttrs :: (String -> a -> b) -> { a } -> { b }
13:52:44
@alejandrosame:matrix.orgalejandrosame
In reply to @johannes.kirschbauer:scs.ems.host
@ronef:matrix.org: i am going on train now. A little Community effort to finish with doc-comments migration would be so nice. Its been a huge milestone and is actually very easy. But a lot of handwork is required. I could make a little guide for how to do it with the hope that some people are willing to jump in for the missing mile
Please, do the guide! I
15:49:19
@alejandrosame:matrix.orgalejandrosame
In reply to @johannes.kirschbauer:scs.ems.host
@ronef:matrix.org: i am going on train now. A little Community effort to finish with doc-comments migration would be so nice. Its been a huge milestone and is actually very easy. But a lot of handwork is required. I could make a little guide for how to do it with the hope that some people are willing to jump in for the missing mile
* Please, do the guide! I'm in the process of revamping my dev setup and this kind of tasks are great for validating it
15:49:47
@johannes.kirschbauer:scs.ems.hostDeleted -Johannes Kirschbauer- reach me via @hsjobeki:matrix.org instead
In reply to @h7x4:nani.wtf

Just a quick question about the lib type signatures - is it an active decision we have made not to note subtypes for attrsets? Or has it just become this way?

# Current state for lists
map :: (a -> b) -> [a] -> [b]

# Current state for attrs
mapAttrs :: (String -> Any -> Any) -> AttrSet -> AttrSet

# I'd like something like this
mapAttrs :: (String -> a -> b) -> { * :: a } -> { * :: b }

# Or alternatively just
mapAttrs :: (String -> a -> b) -> { a } -> { b }
I would like to encurage explicit types. Its something historicially adapted differently everywhere in nixpkgs. I have this repo to try to harmonize them eventually:
https://github.com/hsjobeki/nix-types
16:59:47
@h7x4:nani.wtfh7x4Cool, thanks!17:29:20
@alejandrosame:matrix.orgalejandrosame * Please, do the guide! I'm in the process of revamping my dev setup and this kind of tasks is great for validating it 18:35:43
@noiobeforebedtime:winesj.comJack​ joined the room.23:44:44
26 Oct 2024
@plmh:matrix.orgplmh joined the room.05:20:11
@willbush:matrix.orgwillbush left the room.23:42:03
@willbush:matrix.orgwillbush joined the room.23:43:21
27 Oct 2024
@loher:matrix.orgLorenz joined the room.06:58:28
30 Oct 2024
@seapat:matrix.orgseapat left the room.07:49:55
1 Nov 2024
@gdesforges:matrix.orgGuillaume Desforges changed their profile picture.21:19:02
2 Nov 2024
@mel:rnrd.euMel joined the room.02:56:47
@isabel:isabelroses.comisabel changed their profile picture.10:07:46
4 Nov 2024
@Minijackson:matrix.orgMinijackson

Hey all! I've been developing sphinxcontrib-nixdomain these past months,
which is a project for documenting Nix "objects" in the Sphinx documentation system.

Currently it only support NixOS options, but I plan on adding support for packages and libs.
It's currently missing some documentation (heh) and it's not currently published on PyPi,
but I think it'd be quite a useful project for non-nixpkgs Nix projects.

Here's an example of what it looks like in a real project: https://epics-extensions.github.io/EPNix/nixos-services/options-reference/archiver-appliance.html

Is this something you'd be interested in?
I think I'll be needing help for example to fetch doc comments like nixdoc does.

12:46:32
@fricklerhandwerk:matrix.orgfricklerhandwerkNice, this looks really good. Would definitely be great for nix.dev where we could integrate it right away.13:37:47
@Minijackson:matrix.orgMinijacksonI should work on getting it published and inside nixpkgs, then. Should the project be in nix-community?13:46:15
@Minijackson:matrix.orgMinijacksonNote that right now, the project is only useful for project that define their own NixOS option. I'd like to make a Sphinx role for referring to options defined in nixpkgs, but it's not implemented right now 13:54:19

Show newer messages


Back to Room ListRoom Version: 6