!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

435 Members
Discussion about documentation improvements around the Nix ecosystem91 Servers

Load older messages


SenderMessageTime
23 Aug 2023
@raitobezarius:matrix.orgraitobezarius
In reply to @raitobezarius:matrix.org
Sometimes it's really just random end users with their own way of seeing things
Also I wonder if undeveloped countries have "average" access to 64 bits machine
18:07:38
@raitobezarius:matrix.orgraitobezariusBut well, we kind of already suck for those countries because of how Nix works18:07:56
@infinisil:matrix.orginfinisil I will skip at least tomorrows docs team meetings (but maybe also some following ones) in order to focus on implementing RFC 140. 21:57:07
24 Aug 2023
@brian:bmcgee.ie@brian:bmcgee.ieI have to miss today's meeting aswell, gotta pay the bills08:07:26
@mightyiam:matrix.org@mightyiam:matrix.orgSorry for not being there this time.14:06:24
@raitobezarius:matrix.orgraitobezarius ryantm: I just realized that https://ryantm.github.io/nixpkgs was quite high in search results on Google but outdated 22:34:17
@raitobezarius:matrix.orgraitobezariusCould we do something about this?22:34:21
@raitobezarius:matrix.orgraitobezariuse.g. a robots.txt to reduce its position wrt to SEO22:34:30
@raitobezarius:matrix.orgraitobezarius(we have users citing it in nixpkgs PRs)22:35:11
@proofconstruction:matrix.orgproofconstructionThat makes sense - it's the nixpkgs manual I use when I go looking for something. The mdbook style is so much better than a 50km long page22:49:16
@raitobezarius:matrix.orgraitobezariusIndeed, the problem is that it's not fresh/outdated22:51:36
@raitobezarius:matrix.orgraitobezariusI honestly prefer the 50 km long page :P22:51:46
@raitobezarius:matrix.orgraitobezariusBut I think offering both is not bad at all22:51:54
@ryantm:matrix.orgryantmMany people have told me they like it better than the official manual. I should commit to an update at least every release.23:50:07
@ryantm:matrix.orgryantm!00% not going to make my SEO worse in some way as long as people are telling me they prefer my manual rendering.23:55:40
@ryantm:matrix.orgryantmI'll try to update it this weekend!23:58:35
25 Aug 2023
@raitobezarius:matrix.orgraitobezariusThank you00:05:12
@dylandoesprogramming:matrix.org@dylandoesprogramming:matrix.org left the room.00:05:36
@raitobezarius:matrix.orgraitobezariusThat being said, I feel like it would help a lot to get this "alternative" rendering merged somehow00:06:40
@raitobezarius:matrix.orgraitobezariusI don't have a big opinion on the rendering, but I personally find it hard to navigate the mdbook style and I prefer the long page, some prefers the mdbook and that's fine, we just have contributors who don't know what to do when folks are enforcing rules from the outdated mdbook manual00:07:29
@proofconstruction:matrix.orgproofconstructionUnifying the rendering infrastructure for all the manuals has been discussed often and is on the roadmap https://github.com/nix-community/projects/issues/6, but we don't have the time/energy/(funds to throw at it)/etc currently00:13:20
@raitobezarius:matrix.orgraitobezariusUnderstandable00:15:24
@ryantm:matrix.orgryantm
In reply to @proofconstruction:matrix.org
Unifying the rendering infrastructure for all the manuals has been discussed often and is on the roadmap https://github.com/nix-community/projects/issues/6, but we don't have the time/energy/(funds to throw at it)/etc currently
This is why I made mmdoc in the first place. I wanted to make a documentation rendering system that was lightweight enough to be kept on as part of nixos-rebuild and didn't add to the closure size.
13:44:17
@ryantm:matrix.orgryantmTotally get that I didn't put in the effort to push it over the finish line though, wish I had that energy.13:54:31
@ryantm:matrix.orgryantmI started updating it and it looks like it's mostly just compatible with the existing docs! I think I can make a super small diff that's not too invasive!15:01:00
@raitobezarius:matrix.orgraitobezariusyou mean nrd or mmdoc or something else?15:06:26
@janik0:matrix.org@janik0:matrix.org joined the room.15:11:18
@ryantm:matrix.orgryantmmmdoc15:13:33
@proofconstruction:matrix.orgproofconstruction
In reply to @ryantm:matrix.org
I started updating it and it looks like it's mostly just compatible with the existing docs! I think I can make a super small diff that's not too invasive!
While I think everyone on the docs team agrees that unification of rendering schemes for the manuals is preferable, we haven't had an in-depth discussion around migrating to mmdoc specifically, nor is there really even broad agreement on changing the current system yet. These ideas are very much still in the evaluation phase, rather than planning, so please don't do extra work that might not be used!
20:12:05
@ryantm:matrix.orgryantm proofconstruction: I'm not doing it because I expect you to use it, I'm doing it because I think mmdoc is cool technology that should exist on its own. If it happens to be the best way to solve the unification problem, great. 20:40:49

Show newer messages


Back to Room ListRoom Version: 6