!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

402 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
24 Mar 2024
@roberthensing:matrix.orgRobert Hensing (roberth) Just wrote a testers helper to check links, if you're interested: https://github.com/NixOS/nixpkgs/pull/298665 15:52:38
@dmills27:matrix.orgDominic Mills * Here's my first draft for the Google Season of Docs proposal: https://github.com/DMills27/Nix-Google-Season-of-Docs. I'm continuously working on it. Any criticisms/feedback are welcomed!17:15:34
26 Mar 2024
@cblacktech:matrix.orgcblacktech joined the room.02:02:59
28 Mar 2024
@janne.hess:helsinki-systems.de@janne.hess:helsinki-systems.de joined the room.09:13:17
@pennae:matrix.eno.space@pennae:matrix.eno.space infinisil: reminder that you said you'd review a pr that removes the deprecated docbook support bits from the manual machinery 13:45:43
@fricklerhandwerk:matrix.orgfricklerhandwerk I’ll be in today again. danielsidhion has a write up for how to proceed with the Nixpkgs manual. We also should sync on Google Season of Docs. And whatever else is going on. 14:01:00
@infinisil:matrix.orginfinisil pennae: Ah yeah thanks for the reminder, it's in my notifications backlog, just didn't get to it yet. We might be able to review/merge it in the docs team meeting today, I'll put it on the agenda :) 14:14:57
@danielsidhion:nixos.devdanielsidhion fricklerhandwerk: infinisil Dominic Mills I made after-the-fact notes for the meeting today based on what I remembered, can you check if I missed anything? https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA?edit 20:59:08
@fricklerhandwerk:matrix.orgfricklerhandwerk danielsidhion: posted 21:35:24
@pennae:matrix.eno.space@pennae:matrix.eno.space

https://ethercalc.net/dc4vcnnl8zv0
people.
danielsidhion/fricklerhandwerk.

Does it support GitHub-flavored markdown? [nrd:] If we implement it
Can we render it to multiple pages? [nrd:] If we implement it
How can someone navigate the rendered docs? [nrd:] Single-page output with only immediate children visible on each section

we are increasingly concerned that people don't fucking read what we say. gfm is supported (the manual uses gfm tables!), multipage rendering is in use right now, tocgen is configurable.

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one. should we just fucking leave again?

22:49:06
29 Mar 2024
@sebtm:lodere.esSebTM joined the room.04:23:53
@shalokshalom:kde.org@shalokshalom:kde.org joined the room.05:59:53
@shalokshalom:kde.org@shalokshalom:kde.orgI dont find the Wiki 2 channel anymore06:01:58
@shalokshalom:kde.org@shalokshalom:kde.orgAh, they renamed it 06:57:43
@shalokshalom:kde.org@shalokshalom:kde.org#wiki:nixos.org06:58:00
@danielsidhion:nixos.devdanielsidhion
In reply to @pennae:matrix.eno.space

https://ethercalc.net/dc4vcnnl8zv0
people.
danielsidhion/fricklerhandwerk.

Does it support GitHub-flavored markdown? [nrd:] If we implement it
Can we render it to multiple pages? [nrd:] If we implement it
How can someone navigate the rendered docs? [nrd:] Single-page output with only immediate children visible on each section

we are increasingly concerned that people don't fucking read what we say. gfm is supported (the manual uses gfm tables!), multipage rendering is in use right now, tocgen is configurable.

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one. should we just fucking leave again?

gfm is supported (the manual uses gfm tables!)

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).

multipage rendering is in use right now

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.
When I say multipage, I say the way that we expect chapers and sections to be in their own pages.

tocgen is configurable

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
@danielsidhion:nixos.devdanielsidhionThat 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 factual07:03:17
@shalokshalom:kde.org@shalokshalom:kde.orgAh, a Hickey video I dont know yet ^^07:04:09
@danielsidhion:nixos.devdanielsidhion

infinisil asked as to come back to answer questions regarding the tooling, we've yet to hear one

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
@danielsidhion:nixos.devdanielsidhion
In reply to @shalokshalom:kde.org
Ah, a Hickey video I dont know yet ^^
It'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
@danielsidhion:nixos.devdanielsidhion(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
@efx:matrix.orgEli Flanaganthat book sounds fantastic :)15:13:09
@efx:matrix.orgEli Flanagansilly 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
@efx:matrix.orgEli FlanaganI'm on NixOS too15:13:46
@shalokshalom:kde.org@shalokshalom:kde.org
In reply to @danielsidhion:nixos.dev
(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)
where can I see this spreadsheet please?
15:20:33
@fricklerhandwerk:matrix.orgfricklerhandwerkRedacted or Malformed Event15:21:44
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @efx:matrix.org
silly question: as a contributor, when I make changes to a nixpkgs language markdown file, how do I easily test the manual generates correctly?
*
cd doc
nix-shell
devmode

15:22:25
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @efx:matrix.org
silly question: as a contributor, when I make changes to a nixpkgs language markdown file, how do I easily test the manual generates correctly?
cd doc
nix-shell
devmode
15:23:38
@efx:matrix.orgEli Flanagan
In reply to @fricklerhandwerk:matrix.org
cd doc
nix-shell
devmode
many thanks! I've noted that in my PR testing: https://github.com/NixOS/nixpkgs/pull/300019#issuecomment-2027388055
15:31:15
@danielsidhion:nixos.devdanielsidhion
In reply to @shalokshalom:kde.org
where can I see this spreadsheet please?
It's at https://ethercalc.net/dc4vcnnl8zv0
22:08:00

Show newer messages


Back to Room ListRoom Version: 6