!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

419 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
9 Nov 2023
@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
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Style question: do we capitalize every (important) word in titles, or just the first?
Statistically speaking only the first. The reason is because I find that saner than learning rules that don’t apply for any other parts of the text, and I merged a lot of stuff. Would help to add that to the style guide.
12:49:59
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Style question: do we capitalize every (important) word in titles, or just the first?
* Statistically speaking only the first. The reason is because I find that saner than learning rules that don’t apply for any other parts of the text, and I merged a lot of stuff. Would help to add that to the style guide if we agree on it.
12:50:29
@asymmetric:matrix.dapp.org.ukasymmetricwdym statistically?12:51:09
@asymmetric:matrix.dapp.org.ukasymmetricfwiw i think capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web12:51:38
@asymmetric:matrix.dapp.org.ukasymmetric * fwiw capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web12:51:44
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
wdym statistically?
A large part is like that
12:57:04
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
wdym statistically?
* A large fraction of headings is like that
12:57:14
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
fwiw capitalizing every important word is a known standard (e.g. APA recommends it), but i think it doesn't always look great on the web
It is and I find it stupid but I may be wrong.
12:57:39
@asymmetric:matrix.dapp.org.ukasymmetricthe point of standards is not necessarily that they're the most intelligent solution out there. but point taken 😉 personally, i'm fine with going for sentence-capitalization. i'll open a pr to discuss further12:59:58
@toonn:matrix.orgtoonn It's mostly a US - Europe divide AFAIK. 13:16:32
@Minijackson:matrix.orgMinijacksonthe Microsoft Style Guide recommends sentence-style capitalization: https://learn.microsoft.com/en-us/style-guide/capitalization14:14:02
@Minijackson:matrix.orgMinijacksonwasn't there some efforts recently for adding vale to nix.dev? There's a lint for that14:14:52
@asymmetric:matrix.dapp.org.ukasymmetricmicrosoft.png
Download microsoft.png
14:52:56
@asymmetric:matrix.dapp.org.ukasymmetricseems like they're breaking their own style guide here?14:53:49
@Minijackson:matrix.orgMinijacksonoh you mean "Microsoft Style Guide" ?14:54:22
@Minijackson:matrix.orgMinijacksonI guess so 😆14:54:41

Show newer messages


Back to Room ListRoom Version: 6