Nix Documentation | 415 Members | |
| Discussion about documentation improvements around the Nix ecosystem | 85 Servers |
| Sender | Message | Time |
|---|---|---|
| 16 Mar 2024 | ||
| Since #280592 The documentation is not closely connected to the source anymore. The doc-comment was replaced by an explicit markdown document. Which is fine but we should have a more distinct way of creating a reference to the document such that a doc-comment tool knows that the documentation exists but is located at a different place. We actually will need some more of those „rediretcion-directives“. One task is to research if there are usable standards for that (i some how doubt that) or to come up with a good solution on our own. | 16:19:51 | |
| * Since #280592 The documentation of ‚writeShellApplication’ is not closely connected to the source anymore. The doc-comment was replaced by an explicit markdown document. Which is fine but we should have a more distinct way of creating a reference to the document such that a doc-comment tool knows that the documentation exists but is located at a different place. We actually will need some more of those „rediretcion-directives“. One task is to research if there are usable standards for that (i some how doubt that) or to come up with a good solution on our own. | 16:20:22 | |
| * Since #280592 The documentation of ‚writeShellApplication’ is not closely connected to the source anymore. The doc-comment was replaced by an explicit markdown document. Which is fine but we should have a more distinct way of creating a reference to the document such that a doc-comment tool knows that the documentation exists but is located at a different place. We actually will need some more of those „rediretcion-directives“. One task is to research if there are usable standards for that (i somehow doubt that) or to come up with a good solution on our own. | 16:20:56 | |
| I can help review anything related to nixpkgs manual. Prepending "doc:" to the PR title is the easiest way to get my attention (I keep track of every PR that follows this), but pinging me or requesting review directly from me also does the job | 16:59:26 | |
In reply to @johannes.kirschbauer:scs.ems.hostWith nixdoc taking shape, does anything speak against systematically moving that text into the code? | 17:18:28 | |
| It would still be nice for longer documents like those for stdenv & mkDerivation. | 17:20:40 | |
In reply to @fricklerhandwerk:matrix.orgThere are a few tricky cases that we'll need to handle that requires more thought before doing it right away (one that we already encountered is function with doc-comment that documents inputs, but then more doc-comments on each function argument) | 17:21:19 | |
| Those cases (and what we're doing with them) aren't documented right now, and the way we handle these will likely change in the future, which is why we're being a bit conservative with the move | 17:23:02 | |
oh wow we only now get to see the backlog. someone asked about multipage rendering in nrd it seems? html:into-file makes that happen, the manual already uses that to render the option docs and appendix. isn't automated per chapter/part, but could be added easily (the infra to do this is there already) | 18:13:51 | |
getting the official manual to render multipage is literally just sprinkling html:into-file directives on the includes and letting it build | 18:14:46 | |
| (which, we do want to stress at the risk of offending someone, we have said at least five different times, including in meetings of the docs team) | 18:15:58 | |
| (Without also offending) Was it a lack of contributions? or why don't we have a multi-page outut if it's trivial and has been said so many times? It would be interesting to know whats the root cause then. | 18:56:19 | |
| lack of contributions probably. the topic has come up often enough and we replied how often enough but were burned out enough to not do the splitting work | 18:57:00 | |
| might've also just been forgetten time and time again. | 18:57:52 | |
| I'll definitely look into it. | 18:58:52 | |
| in any case it would be easy to split the manual as is, and with just a little work the split could be done programmatically based on toc structure too. that's part of why the toc data structures are the way they are | 18:59:12 | |
| (we haven't read much of the backlog past seeing that the question must've existed because that part was full of build logs, and the backlog didn't go much further anyway. gotta love matrix) | 19:00:38 | |
| Do you have the issue number? can't find it on the project board. | 19:02:29 | |
| issue number for what? | 19:02:54 | |
| I assumed we had an issue for page splitting. Might not be true then? | 20:52:54 | |
| ah. can't remember one immediately at least | 20:53:50 | |
| yeah, there isn't one we could find either | 20:57:09 | |
| There's some top-level attribute Ideas? | 21:53:40 | |
| * There's some top-level attribute Ideas? | 21:53:58 | |
| set by the flake machinery because it's a git repo, probably | 21:54:42 | |
In reply to @pennae:matrix.eno.space Hm no, at least I don't see how a flake would do that. An empty flake like this:
called with | 21:59:30 | |
In reply to @pennae:matrix.eno.space* Hm no, at least I don't see how a flake would do that. An empty flake in a Git repo, like this:
called with | 21:59:58 | |
| commit it | 22:03:24 | |
| I did | 22:03:31 | |
| shows up having a rev for us | 22:03:47 | |