!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

419 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
22 Jun 2021
@blaggacao:matrix.orgDavid Arnold (blaggacao) * I guess the problem wit list-prs-for-file is the 25 pull request limit: https://github.com/sindresorhus/refined-github/pull/2197/files#diff-26e829c321ccba564beb4bb33adb6e5a71106315a1e35b430d5dd1d7b383aa05R64 17:10:17
@blaggacao:matrix.orgDavid Arnold (blaggacao) What an easy fix on nixpkgs side 17:10:25
@blaggacao:matrix.orgDavid Arnold (blaggacao)🤣😂17:10:32
@blaggacao:matrix.orgDavid Arnold (blaggacao) * I guess the problem wit list-prs-for-file is the 25 pull request limit: https://github.com/sindresorhus/refined-github/pull/2197/files#diff-26e829c321ccba564beb4bb33adb6e5a71106315a1e35b430d5dd1d7b383aa05R64 17:10:43
@blaggacao:matrix.orgDavid Arnold (blaggacao) (at least we now have a technical argument to ramp up the stalebot) 17:55:06
23 Jun 2021
@ryantm:matrix.orgryantmI figured out how to convert the top-level release-notes.xml file to markdown by getting embedded docbook includes to work: https://github.com/ryantm/nixpkgs/commit/aa6b6594ef8f940169b9b426040d0259fd1bc88203:49:16
@ryantm:matrix.orgryantmThis should be useful for the sections of the NixOS manual that are more deeply nested than the Nixpkgs manual.03:55:56
@blaggacao:matrix.orgDavid Arnold (blaggacao)
In reply to @ryantm:matrix.org
I figured out how to convert the top-level release-notes.xml file to markdown by getting embedded docbook includes to work: https://github.com/ryantm/nixpkgs/commit/aa6b6594ef8f940169b9b426040d0259fd1bc882
Maybe the sphinx .. include:: ../README.md is already more familiar to use. There is also Paradox' @@include README.md
11:45:25
@blaggacao:matrix.orgDavid Arnold (blaggacao)* Maybe the sphinx' `.. include:: ../README.md` is already more familiar to use. There is also Paradox' `@@include README.md`11:45:34
@blaggacao:matrix.orgDavid Arnold (blaggacao)Redacted or Malformed Event11:46:17
@blaggacao:matrix.orgDavid Arnold (blaggacao)Redacted or Malformed Event11:54:51
@blaggacao:matrix.orgDavid Arnold (blaggacao)0. `.. include:`11:55:02
@blaggacao:matrix.orgDavid Arnold (blaggacao)[Poll] Which? 0. .. include: myfile.md 1. @@include myfile.md11:55:45
@blaggacao:matrix.orgDavid Arnold (blaggacao)0. .. include: myfile.md11:55:46
@blaggacao:matrix.orgDavid Arnold (blaggacao)I also enjoyed reading https://developer.lightbend.com/docs/paradox/current/directives/index.html12:28:07
@blaggacao:matrix.orgDavid Arnold (blaggacao) Especially the @snip directive: 12:29:46
@blaggacao:matrix.orgDavid Arnold (blaggacao)
@@snip [sysctl.nix](/nixos/sysctl.nix) { #label_filter }
12:31:57
@blaggacao:matrix.orgDavid Arnold (blaggacao)Where label filter is a comment syntax to demark the code region to include into the docs.12:32:27
@blaggacao:matrix.orgDavid Arnold (blaggacao)Those code regions will be tested by hydra, and when the code updates, code regions will have to be updated, too.12:33:03
@blaggacao:matrix.orgDavid Arnold (blaggacao)So less documentation drift.12:33:10
@blaggacao:matrix.orgDavid Arnold (blaggacao)* Where label filter is a code comment syntax to demark the code region to include into the docs.12:33:37
@ryantm:matrix.orgryantmI really don't think includes are necessary in the final thing.13:06:21
@ryantm:matrix.orgryantmThis is just another tool to help us incrementally convert.13:06:58
@blaggacao:matrix.orgDavid Arnold (blaggacao)Ah ok, got ya! 👍13:48:03
@tnias:stratum0.orgtnias joined the room.14:40:10
@jtojnar:matrix.orgJan Tojnar ryantm: I still am not very fond of static global TOC 15:46:36
@jtojnar:matrix.orgJan TojnarI think building the doc tree from included documents like docbook does is better for reducing the chance of merge conflicts, among other things15:49:41
@jtojnar:matrix.orgJan Tojnaralso having the tree would hopefully allow us to have per section TOCs15:50:42
@ryantm:matrix.orgryantmYeah, the per-section TOCs are an improvement, but I'm not sure it is worth the cost of spreading the TOC among multiple files and adding the complexity of includes.16:08:12
@domenkozar:matrix.orgDomen KožarI've refreshed the theme for https://nix.dev/, let me know what you think :)17:17:47

Show newer messages


Back to Room ListRoom Version: 6