!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

434 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
8 Nov 2023
@fricklerhandwerk:matrix.orgfricklerhandwerk * https://discourse.nixos.org/t/a-portable-nix-shell-shebang/35148/2
What do you think? 👍👎? If we want this, anyone interested in seeing it through?
00:27:31
@infinisil:matrix.orginfinisilIt's a bit non-standard, but it seems fine02:27:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @infinisil:matrix.org
It's a bit non-standard, but it seems fine
We could iterate on it
07:38:23
9 Nov 2023
@raboof:matrix.orgraboofdo we have any doc writing guidelines such as "try to avoid words like 'simply'"?09:10:41
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @raboof:matrix.org
do we have any doc writing guidelines such as "try to avoid words like 'simply'"?

Whe have a style guide for nix.dev https://nix.dev/contributing/documentation/style-guide

but no specific note on “simply”.

09:33:34
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @raboof:matrix.org
do we have any doc writing guidelines such as "try to avoid words like 'simply'"?
what's your beef with "simply"? 😃
09:50:15
@raboof:matrix.orgraboofin short, documentation is almost always better without it: it is typically added to encourage the reader, but often has the opposite effect and may even appear condescending, especially when the reader runs into trouble trying to apply the suggestions from the documentation. Best-case it's mostly just noise. I'm sure others have motivated this better than I can in a few sentences though, I can see if I can dig up any good references later - first wanted to see if we had any already.09:55:08
@fricklerhandwerk:matrix.orgfricklerhandwerkIn short: what’s simple for you may be impossible for others. Avoiding that is in line with our stance not to assume things about the reader10:03:08
@fricklerhandwerk:matrix.orgfricklerhandwerk* In short: what’s simple for you may be impossible for others. Avoiding that is in line with our stance not to assume things about the reader and not making value judgements10:03:38
@fricklerhandwerk:matrix.orgfricklerhandwerkThat’s why for instance in reviews I always suggest alternatives to “as you can see…” or “you will see an output…” – no, not everyone can see.10:05:55
@fricklerhandwerk:matrix.orgfricklerhandwerkThere are entire software companies full of people who can’t see.10:07:28
@asymmetric:matrix.dapp.org.ukasymmetricMy pet peeve is "trivial" 😂10:45:38
@fricklerhandwerk:matrix.orgfricklerhandwerk“Left as an exercise for the reader”11:20:52
@infinisil:matrix.orginfinisil Also "just" can have that meaning! 11:41:24
@asymmetric:matrix.dapp.org.ukasymmetrichttps://githubnext.com/projects/copilot-for-docs/11:54:46
@asymmetric:matrix.dapp.org.ukasymmetricis openai gonna write docs for us now?11:56:50
@havk64:matrix.orgAlexandro de Oliveira joined the room.12:28:58
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
is openai gonna write docs for us now?

if we can answer most of developers’ questions directly from the code, we can learn what questions are still unanswered and “interview” maintainers. Instead of writing whole docsets, maintainers are prompted to write one paragraph at a time.

Hm, I don't need AI for that

12:57:03
@i97henka:matrix.orghenrik-chWon't make the doc call today, sorry!14:34:42
@asymmetric:matrix.dapp.org.ukasymmetrichadn't deployment of pr been fixed by delroth?16:21:08
@asymmetric:matrix.dapp.org.ukasymmetric * hadn't deployment of nix.dev prs been fixed by delroth?16:21:13
@asymmetric:matrix.dapp.org.ukasymmetricor am i misremembering?16:21:26
@asymmetric:matrix.dapp.org.ukasymmetrichuh interesting, infinisil's latest commit was deployed, but is marked as "inactive" https://github.com/NixOS/nix.dev/pull/64516:22:12
@asymmetric:matrix.dapp.org.ukasymmetricoh i see, it's because another pr was deployed in the meantime16:23:04
@asymmetric:matrix.dapp.org.ukasymmetricthen i don't know if this integration with github deployments is very useful, since it only keeps one deployment active: https://github.com/NixOS/nix.dev/deployments/pull%20request16:24:06
@asymmetric:matrix.dapp.org.ukasymmetricwhereas the action simply posts a message in a pr with a per-pr deployment16:24:51
10 Nov 2023
@infinisil:matrix.orginfinisilOh yeah those deployments aren't very practical for this purpose..03:49:41
@atka:matrix.org@atka:matrix.org left the room.07:35:22
@harsh-ps-2003-63ce2d0d6da0373984bd6022:gitter.im@harsh-ps-2003-63ce2d0d6da0373984bd6022:gitter.im joined the room.11:23:43
@asymmetric:matrix.dapp.org.ukasymmetricStyle question: do we capitalize every (important) word in titles, or just the first?12:46:16

Show newer messages


Back to Room ListRoom Version: 6