!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

437 Members
Discussion about documentation improvements around the Nix ecosystem94 Servers

Load older messages


SenderMessageTime
25 Jul 2023
@asymmetric:matrix.dapp.org.ukasymmetric cc pennae 10:22:41
@infinisil:matrix.orginfinisil
In reply to @asymmetric:matrix.dapp.org.uk
infinisil: just created this: https://github.com/NixOS/nixpkgs/pull/245358. Not sure how it interacts with https://github.com/NixOS/nixpkgs/issues/244056, I guess whichever gets merged first needs to take the other one into consideration
Yeah, my PR will take a while still, I'll rebase it as needed :)
10:25:12
@asymmetric:matrix.dapp.org.ukasymmetricposting this draft here for early feedback, as the topic is not my area of expertise: https://github.com/NixOS/nixpkgs/pull/24536811:42:44
@asymmetric:matrix.dapp.org.ukasymmetricRedacted or Malformed Event11:43:22
@nikstur:matrix.orgniksturWe have some NixOS documentation outside the nixos/doc/manual tree, e.g.: https://github.com/NixOS/nixpkgs/tree/master/nixos/modules/system/boot/loader/external Is this something we want to support/encourage in the long run? I think it's nice because it keeps the docs close to the code but on the other hand its makes it more difficult for docs contributors to find the source.13:44:55
@nikstur:matrix.orgnikstur * We have some NixOS documentation outside the nixos/doc/manual tree, e.g.: https://github.com/NixOS/nixpkgs/tree/master/nixos/modules/system/boot/loader/external Is this something we want to support/encourage in the long run? I think it's nice because it keeps the docs close to the code but on the other hand it makes it more difficult for docs contributors to find the source.13:45:05
@infinisil:matrix.orginfinisil nikstur: +1 from me, having documentation right next to the implementation makes it easy to update it 13:52:04
@raboof:matrix.orgraboofRedacted or Malformed Event13:59:42
@nikstur:matrix.orgnikstur
In reply to @raboof:matrix.org
yeah, if you can change 'the thing' and 'the documentation for the thing' in the same commit, that's very helpful both when reviewing it and when looking at the change in the history
But this would also be possible if the docs lay somewhere completely different in the repo
14:02:31
@raboof:matrix.orgraboof🤦sorry I misread, nvm14:03:44
@ncfavier:matrix.orgncfavier changed their profile picture.16:43:13
26 Jul 2023
@infinisil:matrix.orginfinisil asymmetric: Ping for https://github.com/nix-community/nixdoc/pull/62 :) 16:50:41
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @infinisil:matrix.org
asymmetric: Ping for https://github.com/nix-community/nixdoc/pull/62 :)
Traveling today, will look at it tomorrow hopefully
19:53:14
27 Jul 2023
@ribosomerocker:matrix.orgribosomerocker joined the room.03:04:09
@quark97:matrix.org@quark97:matrix.org left the room.04:35:42
@viktor:kleen.org@viktor:kleen.org left the room.07:07:34
@alejandrosame:matrix.orgalejandrosameI won't be joining today's meeting. See you next week!12:01:50
29 Jul 2023
@infinisil:matrix.orginfinisilI won't be there for the Monday meeting12:33:54
@proofconstruction:matrix.orgproofconstructionI'm back in civilization and will be at the Monday meeting22:57:22
30 Jul 2023
@h7x4:nani.wtfh7x4 set a profile picture.08:30:49
@asymmetric:matrix.dapp.org.ukasymmetrichttps://discourse.nixos.org/t/nixos-installation-instructions-could-use-a-lot-more-details/31062/6?u=asymmetric16:42:32
@asymmetric:matrix.dapp.org.ukasymmetricIs the SE placement of the manuals something that the marketing team needs to work on (as in SEO), or is it dependent on us, for example by splitting the manual to reduce page load?16:43:47
@alejandrosame:matrix.orgalejandrosameHello all! This issue shouldn't be too problematic, but if you have any considerations to improve the exposition I'll appreciate the feedback: https://github.com/NixOS/nixpkgs/issues/24623418:55:07
@khaneliman:matrix.orgAustin Horstman joined the room.20:03:38
@khaneliman:matrix.orgAustin Horstman changed their display name from Austin Horstman to Khaneliman.20:09:56
@khaneliman:matrix.orgAustin Horstman set a profile picture.20:12:06
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @asymmetric:matrix.dapp.org.uk
Is the SE placement of the manuals something that the marketing team needs to work on (as in SEO), or is it dependent on us, for example by splitting the manual to reduce page load?
It seems to mainly hinge on the page size. Good tagging and summaries of smaller pages would surely have positive impact as well.
21:26:43
@proofconstruction:matrix.orgproofconstruction
In reply to @asymmetric:matrix.dapp.org.uk
Is the SE placement of the manuals something that the marketing team needs to work on (as in SEO), or is it dependent on us, for example by splitting the manual to reduce page load?
It seems to mainly hinge on the page size. Good tagging and summaries of smaller pages would surely have positive impact as well.
22:40:52
@proofconstruction:matrix.orgproofconstructiongenuinely no idea what happened there. i guess i forwarded that message to this channel? finding some rough edges in fluffychat apparently!22:41:22
@proofconstruction:matrix.orgproofconstruction
In reply to @alejandrosame:matrix.org
Hello all! This issue shouldn't be too problematic, but if you have any considerations to improve the exposition I'll appreciate the feedback: https://github.com/NixOS/nixpkgs/issues/246234
this is great - i really like the idea of labeling every (sub)section with the relevant diataxis category as a first step
22:43:09

Show newer messages


Back to Room ListRoom Version: 6