Nix Documentation | 419 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 87 Servers |
| Sender | Message | Time |
|---|---|---|
| 29 Mar 2024 | ||
| Ah, they renamed it | 06:57:43 | |
| #wiki:nixos.org | 06:58:00 | |
In reply to @pennae:matrix.eno.space
gfm tables isn't the complete set of gfm, and from what I saw the current code doesn't support the full set (more importantly, doesn't support the github note/tip/warning box style).
The manuals aren't rendered in multiple pages and we have already established that it's not about just toggling a switch. If you render the manual in multiple pages, links break. It requires more effort than just a switch.
It's already understood that we can change nrd's implementation the way we see fit, but for that particular line what matters is what the tool currently does | 07:00:20 | |
| That spreadsheet is being done in decision-matrix style following this rich hickey talk: https://www.youtube.com/watch?v=c5QF2HjHLSE The objective is to be factual in each cell while filling it. I think the current text in the cells reflect the current facts, but I can make mistakes. Please point them out (and thank you for caring enough to read through it!). I still think the cells you called out are factual | 07:03:17 | |
| Ah, a Hickey video I dont know yet ^^ | 07:04:09 | |
As for this, I wanted to have that spreadsheet filled out before engaging in review, and then in its discussion, where questions and discussion about the tooling would be most important (and having the fresh discussion would be helpful IMO). I haven't had enough time to dedicate lately to filling out the sheet. It's something that will get done eventually as I put more effort in. | 07:07:41 | |
In reply to @shalokshalom:kde.orgIt's a pretty good one. I'm currently reading the book he recommends on the socratic method and it's been pretty good as well | 07:09:07 | |
| (I just updated the spreadsheet to reflect that gfm tables are supported for nrd, and the rest of it if we implement it. I think it's a better reflection of the facts. Thank you again for calling it out) | 07:11:18 | |
| that book sounds fantastic :) | 15:13:09 | |
| silly question: as a contributor, when I make changes to a nixpkgs language markdown file, how do I easily test the manual generates correctly? | 15:13:40 | |
| I'm on NixOS too | 15:13:46 | |
In reply to @danielsidhion:nixos.devwhere can I see this spreadsheet please? | 15:20:33 | |
| Redacted or Malformed Event | 15:21:44 | |
In reply to @efx:matrix.org* | 15:22:25 | |
In reply to @efx:matrix.org | 15:23:38 | |
In reply to @fricklerhandwerk:matrix.orgmany thanks! I've noted that in my PR testing: https://github.com/NixOS/nixpkgs/pull/300019#issuecomment-2027388055 | 15:31:15 | |
In reply to @shalokshalom:kde.orgIt's at https://ethercalc.net/dc4vcnnl8zv0 | 22:08:00 | |
| thx | 23:44:16 | |
| 30 Mar 2024 | ||
| 00:41:00 | ||
| 04:15:31 | ||
| 31 Mar 2024 | ||
| 18:01:32 | ||
In reply to @alejandrosame:matrix.orgNot sure but i think i am somewhat working on this indirectly. I am doing value introspection. Which seems to be the same here. But i try to do a more generic approach to find all lambdas, lambda arguments, functors, and so on recursively for any nix expression. Will take some time though until it is done | 18:32:36 | |
| 20:35:10 | ||
| 22:32:54 | ||
| 23:07:02 | ||
| 1 Apr 2024 | ||
| 03:24:41 | ||
| So is nrd its own extension of github flavored markdown? | 03:30:08 | |
| 04:43:52 | ||
In reply to @paperdigits:matrix.orgmore a combination of commonmark (because the documentation rfcs specified commonmark as the language to use), gfm features, myst features, and a few custom additions. it doesn't support all gfm features, but it does support tables. the rest isn't all that useful for the nixos/nixpkgs manual usecase (task lists aren't useful in a non-interactive setting and can be rendered differently anyway, in general shouldn't be used because parts render out to manpages and can't support html, etc). | 12:21:44 | |
| https://discourse.nixos.org/t/wiki-nixos-org-is-now-live/42570 | 14:05:53 | |