Nix Documentation | 435 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 91 Servers |
| Sender | Message | Time |
|---|---|---|
| 6 Nov 2023 | ||
| I guess just an introductory section giving an overview of all sublibraries would be better | 11:53:22 | |
| if at all. Most library reference material doesn't bother with that kind of thing | 11:54:04 | |
| not sure that we should | 11:54:11 | |
In reply to @antifuchs:asf.computer For reference documentation I'm also more into alphabetical order and then linking as necessary to building blocks (for example, the proposal in https://github.com/NixOS/nixpkgs/issues/250376). Other types of documents can order as they want, ofc, since the whole point is to set up an order that makes sense for storytelling, task completion, etc. | 12:20:20 | |
In reply to @infinisil:matrix.orgThis would be better as a page on nix.dev | 14:36:53 | |
| Hmm I think reference docs can also use overviews of its parts, it doesn't really fit into tutorials, guides or explanation | 14:39:47 | |
| Overviews are important, and should be right there with the reference docs. Reference will change, and while the prose overview may not catch up immediately, it's way easier to keep it in sync when it's in-tree. | 14:56:28 | |
In case I just mass review-requested everyone on nix.dev, I apologize. I was trying to fix an erroneous push. Who are the administrators of the repo? We should enable branch protection on master to require a PR with approval before merging | 16:42:33 | |
| fun artifact of building nix.dev with flakes: the footer says "Copyright 2016-1980" | 16:46:24 | |
| * fun artifact of building nix.dev with nix: the footer says "Copyright 2016-1980" | 16:46:31 | |
| Wait, this is not 1970? | 16:52:28 | |
In reply to @infinisil:matrix.orgThe way I see it is like dictionaries: you can add extra sections (intros, overviews, historical explanations, etc) but the indexing of the entries is alphabetical to ease its navigation. | 17:02:30 | |
| I'm with you that being too terse is in general problematic for documentation. | 17:04:09 | |
In reply to @nbp:mozilla.orgI think 1980 is the default SOURCE_DATE_EPOCH | 17:51:44 | |
| isn't that the 1st of 1970? To which we added a few seconds because of gnumake? | 18:02:01 | |
| ZIP can only represent dates starting from 1980, my guess is that that's why it would be 1980 and not 1970 | 18:04:44 | |
| 18:28:44 | |
| I've drafted a small RFC to use nix.dev as the canonical name (but there's also alternatives), would appreciate some quick feedback: https://github.com/nix-rfc-canonical-domain/rfcs/blob/canonical-domain/rfcs/1000-canonical-domain.md | 20:36:48 | |
| * I've drafted a small RFC to use nix.dev as the canonical domain name (but there's also alternatives), would appreciate some quick feedback: https://github.com/nix-rfc-canonical-domain/rfcs/blob/canonical-domain/rfcs/1000-canonical-domain.md | 20:37:52 | |
In reply to @infinisil:matrix.orgThere should be very few things that deserve an RFC. This is one of them. | 20:41:34 | |
| this feels like it should have a mention of the nixos dot com problem :-) | 20:44:40 | |
| * this RFC feels like it should have a mention of the nixos dot com problem :-) | 20:44:52 | |
In reply to @delroth:delroth.netRight. And if it comes to a conclusion we may want to task the foundation to exercise their trademark rights on that basis. | 20:52:55 | |
| Btw I also asked in the governance room, where there's some more discussion already: https://matrix.to/#/!VyoUhyWvlhSpFWWxHL:matrix.org/$WUV3OUgwKv_EQkOVQTSOE6WCjbck9oof4nEmzLSy1p8?via=nixos.org&via=matrix.org&via=matrix.dapp.org.uk | 20:55:59 | |
| 7 Nov 2023 | ||
| 06:58:35 | ||
In reply to @infinisil:matrix.orgin future work you could list that the implementation of the currently two websites could be unified. or maybe not. but it's a question that i had. you could also declare it as explicitly out of scope. | 10:05:35 | |
In reply to @asymmetric:matrix.dapp.org.ukSounds good, can you PR that? :D | 10:52:14 | |
In reply to @infinisil:matrix.orgas future work or as out of scope? | 10:54:21 | |
In reply to @asymmetric:matrix.dapp.org.ukI don't think there's an out of scope section. Future work sounds good | 10:56:06 | |
| 8 Nov 2023 | ||
| https://discourse.nixos.org/t/a-portable-nix-shell-shebang/35148/2 What do you think? If we want this, anyone interested in seeing it through? | 00:26:48 | |