!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

446 Members
Discussion about documentation improvements around the Nix ecosystem94 Servers

Load older messages


SenderMessageTime
11 Aug 2022
@denna:matrix.orgolaf I just opened this PR I would like to know if the direction is appreciated. 13:30:26
@denna:matrix.orgolaf changed their display name from denna to olaf.13:30:58
@Ericson2314:matrix.orgJohn Ericsonhttps://github.com/NixOS/nix/pull/6420#issuecomment-120622636415:40:04
@infinisil:matrix.orginfinisilhttps://github.com/orgs/NixOS/projects/15/views/115:52:06
@joerg:thalheim.ioMic92 John Ericson: https://hackmd.io/8MbOj5cfSF6QHw4J_tQVxw?edit 15:56:19
@denna:matrix.orgolafhttps://github.com/NixOS/nix-book/blob/main/resources.md15:59:05
@denna:matrix.orgolaf
In reply to @denna:matrix.org
I just opened this PR I would like to know if the direction is appreciated.
here
16:02:27
@Ericson2314:matrix.orgJohn Ericson Mic92: we didn't discuss that much but I liked your nix.dev PR 16:43:10
@Ericson2314:matrix.orgJohn Ericsongood indeed to introduce problem separate from niv16:43:17
@joerg:thalheim.ioMic92 John Ericson: I think you mean someone else? I don't think I created such a PR. 16:44:44
@Ericson2314:matrix.orgJohn Ericson oh yes oops that was olaf with https://github.com/NixOS/nix.dev/pull/303/files 16:45:13
@Ericson2314:matrix.orgJohn Ericsonmy ad16:45:17
@fufexan:matrix.orgfufexan

I was thinking of adding setting nixPath from flakes inputs to the wiki. Should that be done in the Flakes article or in a new article? It's basically only

{ inputs, ... }:
{
  nix.nixPath = [
    "nixpkgs=${inputs.nixpkgs}"
    "home-manager=${inputs.home-manager}"
    "system=${inputs.self}"
  ];
}

This would go along with showing how to add specialArgs = { inherit inputs; }; to a nixosSystem call.

Should I add this at all?

19:46:01
@fufexan:matrix.orgfufexan *

I was thinking of adding setting nixPath from flakes inputs, for compatibility with older nix tools, to the wiki. Should that be done in the Flakes article or in a new article? It's basically only

{ inputs, ... }:
{
  nix.nixPath = [
    "nixpkgs=${inputs.nixpkgs}"
    "home-manager=${inputs.home-manager}"
    "system=${inputs.self}"
  ];
}

This would go along with showing how to add specialArgs = { inherit inputs; }; to a nixosSystem call.

Should I add this at all?

19:46:44
12 Aug 2022
* @ShadowRZ:matrixim.cc夜坂雅 | Yorusaka Miyabi wonders if there's any requirements for NixOS documentation to use DocBook.01:42:12
@pennae:matrix.eno.spacepennaepretty much everything except modules and the options we haven't touched yet use markdown as their primary format and just render to docbook as an intermediate format. some modules do that as well, albeit not automatically01:47:31
@ShadowRZ:matrixim.cc夜坂雅 | Yorusaka Miyabi
In reply to @pennae:matrix.eno.space
pretty much everything except modules and the options we haven't touched yet use markdown as their primary format and just render to docbook as an intermediate format. some modules do that as well, albeit not automatically
I thought that, eventually all NixOS module option docstrings are written in CommonMark.
02:55:24
@pennae:matrix.eno.spacepennaethat's the plan :)02:56:11
@pennae:matrix.eno.spacepennaehope we'll get there for 22.1102:56:18
@pennae:matrix.eno.spacepennaecurrently waiting for review on https://github.com/NixOS/nixpkgs/pull/185474 before we go any further02:57:00
@ShadowRZ:matrixim.cc夜坂雅 | Yorusaka Miyabi
In reply to @pennae:matrix.eno.space
currently waiting for review on https://github.com/NixOS/nixpkgs/pull/185474 before we go any further
In this PR I found that there's a remaining part that looks like DocBook. 😅
03:34:59
@ShadowRZ:matrixim.cc夜坂雅 | Yorusaka MiyabiThis PR looks good to me. BTW, is lib.mdDoc a marker ?03:36:43
@pennae:matrix.eno.spacepennae it wraps the given text in a form make-options-doc recognizes as markdown so it can convert it to docbook, yes 03:38:09
@Ericson2314:matrix.orgJohn Ericsonhttps://github.com/NixOS/nix/pull/6877#issuecomment-1212877941 Eelco commented providing more details why he doesn't like the arch chapter, and seems to be anti having a reference17:02:06
@Ericson2314:matrix.orgJohn Ericson(I wrote that in the Nixpkgs arch chanel, but I meant to write that in this channel)17:03:02
@Ericson2314:matrix.orgJohn EricsonBased on our call yesterday, I think we all disagree with that?17:03:19
@Ericson2314:matrix.orgJohn Ericsonso it would be good to do something as a team about that17:03:27
@tpw_rules:matrix.orgtpw_rulesis there a way to automatically extract that stuff into something that's not doxygen?19:13:48
@Ericson2314:matrix.orgJohn Ericson tpw_rules: not in a good way 19:27:28
@Ericson2314:matrix.orgJohn Ericsondoxygen is is per defintion code decs19:27:39

Show newer messages


Back to Room ListRoom Version: 6