!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

412 Members
Discussion about documentation improvements around the Nix ecosystem82 Servers

Load older messages


SenderMessageTime
30 Jul 2023
@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
@proofconstruction:matrix.orgproofconstructionre: the installation guide on the wiki coming up in top search engine results - this is (in my opinion) another great reason to make an actually-official one (wiki.nixos.org?) that still has community-generated content. not really sure what happened historically to yield the present state of affairs, but it's confusing and bad as everyone keeps pointing out22:46:20
@proofconstruction:matrix.orgproofconstructionthat is, community-generated in the sense of not being largely dependent on stewardship by the docs team, which is still under-resourced22:47:03
31 Jul 2023
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @fricklerhandwerk:matrix.org
It seems to mainly hinge on the page size. Good tagging and summaries of smaller pages would surely have positive impact as well.

indeed:

  • https://pagespeed.web.dev/analysis/https-nixos-org-manual-nixos-stable/0jv7c6prdy?form_factor=desktop
  • https://pagespeed.web.dev/analysis/https-nixos-wiki-wiki-NixOS_Installation_Guide/6d6uu0tx4h?form_factor=desktop
09:22:57
@pennae:matrix.eno.space@pennae:matrix.eno.space looking at the meeting notes; henrik-ch: for which manual are you looking for alternatives? 15:40:40
@pennae:matrix.eno.space@pennae:matrix.eno.spaceor rather, what's the goal for that manual regardless of tooling15:42:13
@i97henka:matrix.orghenrik-ch Hi pennae , thank you for reaching out - when you read the meeting minutes, you may think that I am doing something or being very concrete about manual rendering alternatives, but that is not the case, rather I am being very unconcrete I would say 😀. 15:49:05
@i97henka:matrix.orghenrik-chWhat I have seen and been impressed by is https://ryantm.github.io/nixpkgs/ and I took a look to see how it's been rendered, that's all. I am still very much a beginner to all these things.15:50:22
@pennae:matrix.eno.space@pennae:matrix.eno.spacewe're just a little confused by the generic "alternative manual rendering" juxtaposed with a "nixpkgs" url. nixos-render-docs is itself an alternative/replacement of mmdoc because mmdoc is such a nightmare to extend15:50:58
@i97henka:matrix.orghenrik-ch
In reply to @pennae:matrix.eno.space
we're just a little confused by the generic "alternative manual rendering" juxtaposed with a "nixpkgs" url. nixos-render-docs is itself an alternative/replacement of mmdoc because mmdoc is such a nightmare to extend
You clearly know a lot more about this topic than I do! I am sorry if the statements caused confusion or concern.
15:52:04
@pennae:matrix.eno.space@pennae:matrix.eno.spacewe're happy to explain if you have any questions15:53:39
@ryantm:matrix.orgryantmWhat is "such a nightmare to extend" based upon?17:34:54
@ryantm:matrix.orgryantmIs merely using C as the implementation language enough to brand it as such?17:35:27
@pennae:matrix.eno.space@pennae:matrix.eno.spacepersonal experience; we tried to add an extension (forget which one it was, unfortunately) and just gave up after a while because it kept segfaulting and misbehaving in other ways :/17:55:23
@pennae:matrix.eno.space@pennae:matrix.eno.spaceyou did an amazing job getting it as far as it is, but that experience and the many pitfalls of complex software written in C have us worry that it won't be very maintainable by anyone except you17:57:08
@ryantm:matrix.orgryantmAlright, well I'm still actively working on improving it, so if you have feature requests I'd be interested in hearing them.20:03:12
@pennae:matrix.eno.space@pennae:matrix.eno.space currently there's nothing pressing since nixos-render-docs has kind of become the renderer for nixpkgs/nixos 😶 20:05:09
@pennae:matrix.eno.space@pennae:matrix.eno.spacewe're not attached to the tool at all, if you can do better with mmdoc then by all means go for it20:07:13
@pennae:matrix.eno.space@pennae:matrix.eno.spacebut maintainability is a concern we have, and python does tend to be easier on contributors than C20:08:11
1 Aug 2023
@charles:computer.surgeryCharles changed their profile picture.01:12:22
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @pennae:matrix.eno.space
but maintainability is a concern we have, and python does tend to be easier on contributors than C
I second that. From everyone I read of or talked to about documentation (I’m mainly in touch with a bunch of Haskellers) I got convinced we should put extraordinary emphasis on low tech tooling, meaning they should be easily accessible to the average user. Python ans Markdown fit the bill better than, say, C and ReST
08:33:21
@rigille:matrix.orgRígille S. B. MenezesHey I'm new here, just wanted to share this because I think giving more emphasis on this tip would be a good idea in the documentation https://twitter.com/sullyj3/status/168623170344522137713:29:32
@asymmetric:matrix.dapp.org.ukasymmetric
In reply to @rigille:matrix.org
Hey I'm new here, just wanted to share this because I think giving more emphasis on this tip would be a good idea in the documentation
https://twitter.com/sullyj3/status/1686231703445221377
hey, welcome! That command is marked as experimental, and as such it is currently out of scope for nix.dev
13:34:05

Show newer messages


Back to Room ListRoom Version: 6