!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

398 Members
This is the official channel for documentation in the Nix ecosystem. The documentation team meets here. More information: https://nixos.org/community/teams/documentation Video conference: https://jitsi.lassul.us/nix-documentation Meeting notes scratch pad: https://pad.lassul.us/p-Y8MjU2SdSD5qO1fnpCPA Past meeting notes: https://discourse.nixos.org/search?q=documentation%20team%20meeting%20order%3Alatest 75 Servers

You have reached the beginning of time (for this room).


SenderMessageTime
2 Jul 2024
@djacu:matrix.orgdjacu
In reply to @johannes.kirschbauer:scs.ems.host
djacu: no the RFC is not strict in those terms. danielsidhion and me worked on what is more like conventions. There are other files in lib that use commonmark already in comments for reference

Ah okay. I saw things like this and wasn't sure.

# Inputs

    `f`
    : 1\. Function argument

I do like it though!

17:28:37
4 Jul 2024
@philiptaron:matrix.orgPhilip Taron (UTC-8) left the room.15:46:27
@philiptaron:matrix.orgPhilip Taron (UTC-8) joined the room.15:56:12
@soispha:vhack.euBenedikt changed their display name from Soispha to Benedikt.19:10:58
5 Jul 2024
@devurandom:matrix.orgDennis joined the room.20:18:47
@sliedes:hacklab.fiSami Liedes joined the room.23:03:10
@sliedes:hacklab.fiSami Liedes

Hey. I'm a new NixOS user, already trying to heavily use the documentation. :) Someone pointed out to me that there's two wikis, with a difference. I've been looking at the NixOS manual, but had missed at least this.

Now I'm looking for glossaries. Is this the best we have? https://nix.dev/manual/nix/2.23/glossary.html#gloss-store-derivation

I could perhaps contribute (as in I can make a PR) by... Hm. My initial idea would be to at least

  1. Sort it; now it's hard to find anything in it
  2. I actually think that page could use a TOC. Or some kind of a layout change, I'm not sure. Now if I want to find something on it, my best bet is to do a search in browser, and that hits other mentions of the word.

Also I feel it's missing quite a few pieces of terminology that I've run into a lot the past few days. I think at least module, option, store, package, flake, home manager.

Then I don't know what of those are Nix and what are NixOS. Is there a hard split between "Nix documentation" and "NixOS documentation"? (Though if we expect a newcomer to know which manual to look in, maybe that's a problem in itself?)

23:11:29
@sliedes:hacklab.fiSami Liedes *

Hey. I'm a new NixOS user, already trying to heavily use the documentation. :) Someone pointed out to me that there's two wikis, with a difference. I've been looking at the NixOS manual, but had missed at least this.

Now I'm looking for glossaries. Is this the best we have? https://nix.dev/manual/nix/2.23/glossary.html#gloss-store-derivation

I could perhaps contribute (as in I can make a PR) by... Hm. My initial idea would be to at least

  1. Sort it; now it's hard to find anything in it
  2. I actually think that page could use a TOC. Or some kind of a layout change, I'm not sure. Now if I want to find something on it, my best bet is to do a search in browser, and that hits other mentions of the word.

Also I feel it's missing quite a few pieces of terminology that I've run into a lot the past few days. I think at least module, option, store, package, generation, flake, home manager.

Then I don't know what of those are Nix and what are NixOS. Is there a hard split between "Nix documentation" and "NixOS documentation"? (Though if we expect a newcomer to know which manual to look in, maybe that's a problem in itself?)

23:14:56

Show newer messages


Back to Room ListRoom Version: 6