!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

418 Members
Discussion about documentation improvements around the Nix ecosystem86 Servers

Load older messages


SenderMessageTime
6 Dec 2023
@bzzm3r:matrix.org@bzzm3r:matrix.orgSounds good, yeah, I'll start up that sequence of PRs soon!02:51:02
@bzzm3r:matrix.org@bzzm3r:matrix.org In the meantime, the continuation of proofconstruction's PR from August is now ready to be reviewed! 02:51:26
@bzzm3r:matrix.org@bzzm3r:matrix.orghttps://github.com/NixOS/nix.dev/pull/83102:51:27
@philiptaron:matrix.orgPhilip Taron (UTC-8) joined the room.04:52:55
7 Dec 2023
@proofconstruction:matrix.orgproofconstructionWill take a look this afternoon, thanks!15:51:27
@ibizaman:matrix.orgibizaman
In reply to @ibizaman:matrix.org

Hi everyone. Thank you for all your efforts on the nix documentation. It is really a treasure trove of information that I use just about all the time.

I tried using `nixos-render-docs` on my project’s manual. I was lured away from nvmd thanks to this new tool able to parse markdown files instead. But then I stumbled into a few issues. One is about embedding pictures from nested directories. I’ll create an issue and test and PR soon about that one.

I did create an issue about the main blocking one for me https://github.com/NixOS/nixpkgs/issues/272329.

I just started looking at that tool’s code and it’s still not obvious to me how all works together to create html files. But if you deem solving this issue in the tool worth it, I’m happy to invest some time on this.  

Happy to report my issue is resolved! <3
19:20:27
8 Dec 2023
@9999years:matrix.org@9999years:matrix.org joined the room.19:55:35
9 Dec 2023
@lennart:0520.chlennart (this account will be deactivated by 1st of may 2025) joined the room.19:24:12
@git_lit_mit_ohne_dir:matrix.org@git_lit_mit_ohne_dir:matrix.org joined the room.20:43:08
@bzzm3r:matrix.org@bzzm3r:matrix.org infinisil: it seems that getting a google API key requires entering credit card information 21:09:32
@bzzm3r:matrix.org@bzzm3r:matrix.orghttps://nix.dev/tutorials/module-system/module-system21:09:33
@bzzm3r:matrix.org@bzzm3r:matrix.org * infinisil: it seems that getting a google API key requires entering credit card information, which makes it not so easy to follow along with this: 21:09:49
@bzzm3r:matrix.org@bzzm3r:matrix.org what i'll do for now to follow the tutorial is change the map/geocode scripts so that they emit dummy information to stdout, rather than make actual API calls 21:10:32
@git_lit_mit_ohne_dir:matrix.org@git_lit_mit_ohne_dir:matrix.org left the room.21:45:36
10 Dec 2023
@infinisil:matrix.orginfinisil
In reply to @bzzm3r:matrix.org
infinisil: it seems that getting a google API key requires entering credit card information, which makes it not so easy to follow along with this:
bzm3r: Yeah it sucks a lot. We didn't have the resources to rewrite it into something more open
00:11:39
@infinisil:matrix.orginfinisil
In reply to @bzzm3r:matrix.org
what i'll do for now to follow the tutorial is change the map/geocode scripts so that they emit dummy information to stdout, rather than make actual API calls
Yeah that works too, ideally the tutorial would be adapted to a more open mapping api
00:12:35
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @infinisil:matrix.org
bzm3r: Yeah it sucks a lot. We didn't have the resources to rewrite it into something more open

no worries at all, I'll submit a PR if I can something simpler.

I don't know much about open map APIs, so I want to be careful about not opening up another rabbithole...is there one that you recommend?

02:34:49
@bzzm3r:matrix.org@bzzm3r:matrix.org
In reply to @infinisil:matrix.org
bzm3r: Yeah it sucks a lot. We didn't have the resources to rewrite it into something more open
*

no worries at all, I'll submit a PR if I can determine something simpler.

I don't know much about open map APIs, so I want to be careful about not opening up another rabbithole...is there one that you recommend?

02:35:01
@proofconstruction:matrix.orgproofconstructionOpenStreetMap is the gold standard here; converting that tutorial to use it would be a huge service07:15:14
@bzzm3r:matrix.org@bzzm3r:matrix.orgSounds good. I can work towards that. I ultimately ended up going through that entire tutorial without running the examples, so I think I am in an okay position to try and make that conversion11:20:28
@rootname:matrix.org@rootname:matrix.org joined the room.12:07:55
13 Dec 2023
@ryantm:matrix.orgryantmGitHub now supports an admonition syntax: https://github.com/openai/openai-python/blob/9e6e1a284eeb2c20c05a03831e5566a4e9eaba50/README.md?plain=1#L1705:12:44
@infinisil:matrix.orginfinisil ryantm: It did before, but the syntax changed now, breaking all usages of the old syntax. Apparently it was a beta feature, but people are angry about it 😅 https://github.com/orgs/community/discussions/16925 05:15:58
@infinisil:matrix.orginfinisilIndeed I had to update the CONTRIBUTING.md with the new syntax: https://github.com/NixOS/nixpkgs/pull/27239805:16:28
@infinisil:matrix.orginfinisilThey also broke them for list items..05:17:05
@infinisil:matrix.orginfinisil * They also broke them for list items.. https://github.com/NixOS/nixpkgs/pull/272398/commits/e88fb997e32982a5f37b933583e618265a32d85d05:17:32
@ryantm:matrix.orgryantmAha, thanks for fixing!05:17:54
14 Dec 2023
@jade_:matrix.org@jade_:matrix.org

infinisil: re this: https://github.com/NixOS/nixpkgs/pull/270696#discussion_r1412898648

this is emblematic of a larger set of problems we have:

  • CONTRIBUTING.md is a guide level explanation of things, and is already too bloody long. It is the wrong place to provide reference level material about our vision for docs.
  • Relatedly, we need to write these vision documents down.
  • We don't have a https://rustc-dev-guide.rust-lang.org/ for Nix, and we need one desperately. We should make one and start moving things to it.
  • We don't have a repo to file meta issues like I am talking about here, and we need one. Another issue that should be filed in there is "hydra notifications for failed maintained packages", for example.
  • All the places that docs go have different stylesheets and don't link to each other, both as deep links and even shallow links. This gives the impression that they're not part of a coherent ecosystem with one responsible set of people.
  • Our current docs splitting work is partially counterproductive due to this lack of links; but would be strongly positively improved by adding links.

I might post these things to discourse to try to get some of the things to make a "nix development guide" mdbook site happen. On a broad level, a remarkable amount of contributor frustration is caused by this communication gap. The lack of meta issue tracker is also very painful since it would be useful to ask for help for these things, but they're not written down in a coherent place to actually do them.

21:13:48
@jade_:matrix.org@jade_:matrix.org cc raitobezarius as i have mentioned this a couple of times 21:20:46
@jade_:matrix.org@jade_:matrix.orgoh, another one, the website needs to have the "community" page split from the "teams" information, going to go file an issue for that one21:37:37

Show newer messages


Back to Room ListRoom Version: 6