!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem93 Servers

Load older messages


SenderMessageTime
4 Aug 2022
@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
@Ericson2314:matrix.orgJohn Ericsonand then I get into the gory details of files, the exact way we hash store objects, etc.15:24:26
@Ericson2314:matrix.orgJohn Ericson * and then I get into the gory details of files directories symlinks, the exact way we hash store objects and render store paths, etc.15:24:45
@denna:matrix.orgolafas a initial comment. i am suspicious of the suggestion to use pseudo code but need to render it to see how it feels. 16:05:47
@tpw_rules:matrix.orgtpw_rulesmaybe it's me, but i'm not sure i like starting out the docs even farther away from actual nix16:30:52
@tpw_rules:matrix.orgtpw_rulesoh i see there is commentary on this in the issue16:32:19
@yuu:matrix.orgyuu changed their display name from yuu to YourNick.17:41:38
@yuu:matrix.orgyuu changed their display name from YourNick to yuu[m].17:42:23
@Ericson2314:matrix.orgJohn Ericson denna: I am fine if the pseuco code data structures become diagrams some how 17:58:33
@Ericson2314:matrix.orgJohn Ericson tpw_rules: FWIW my long term hope is that if Nix starts supporting things like WASI/WASM and whatever else, the abstract model will become more than idea in our heads, but also what ties everything together 17:59:21
@Ericson2314:matrix.orgJohn EricsonI created new types of content addressing for the IPFS stuff for example (an option for "deep content addressing, were references are not arbitrary store paths but something more structured that prooves it is content addressed all the way down)18:00:26
@Ericson2314:matrix.orgJohn EricsonOne could just document every instance of the general idea, but one is left then with a big bag of special cases with the underlying theme left as an exercise to the reader18:01:19
@tpw_rules:matrix.orgtpw_rulesbut regular content addressing isn't even a common thing yet. i feel like 90% of nix users and initial observers want to know about package management18:02:12
@Ericson2314:matrix.orgJohn Ericsonregular content addressing of store objects is common18:02:34
@Ericson2314:matrix.orgJohn Ericsonthat is how all source code wroks18:02:39
@Ericson2314:matrix.orgJohn Ericson * that is how all source code works18:02:42
@Ericson2314:matrix.orgJohn Ericson more broadly I am trying to write the reference 18:02:53
@Ericson2314:matrix.orgJohn Ericsonwhich includes all the things without deciding what is more important or not18:03:05

Show newer messages


Back to Room ListRoom Version: 6