!avYyleMexqjFHoqrME:nixos.org

Nix Documentation

405 Members
Discussion about documentation improvements around the Nix ecosystem80 Servers

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


SenderMessageTime
24 Sep 2024
@phanirithvij:matrix.orgloudgolem@johannes.kirschbauer:scs.ems.host is there a noogle matrix channel?08:00:49
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @phanirithvij:matrix.org
has anything been done for rendering docs in multiple pages since this discussion?

As far as i am aware no. Pennae seems to do lix now. nixos-render-docs is now kind of unmaintained?
Multipage rendering can be done, and it should be a straight forward task.
Here are the steps that i have in my head rn.

  • build a table of track references (currently anchors)

  • split the manual during rendering into mutliple output pages (and where each reference is located)

  • make sure the references point to the correct subpage in output

  • write a client side redirect script for people having the old references

08:01:29
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host
In reply to @phanirithvij:matrix.org
@johannes.kirschbauer:scs.ems.host is there a noogle matrix channel?
No. But you can ask questions here as well i guess
08:02:29
@phanirithvij:matrix.orgloudgolemin the readme it is mentioned pagefind is only available in the production build08:03:07
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host danielsidhion: Is also kind of afk since ~springtime havent heard anything from him 08:03:24
@phanirithvij:matrix.orgloudgolemif I wish to self host noogle locally do I need pagefind08:03:26
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostPagefind is the search engine, so yes, if you want the search.08:04:25
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host "Production build" means npm run build 08:04:57
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostIts a completely static page, you can selfhost it.08:05:15
@phanirithvij:matrix.orgloudgolemok I'll try it out08:05:48
@fricklerhandwerk:matrix.orgfricklerhandwerk
In reply to @johannes.kirschbauer:scs.ems.host

As far as i am aware no. Pennae seems to do lix now. nixos-render-docs is now kind of unmaintained?
Multipage rendering can be done, and it should be a straight forward task.
Here are the steps that i have in my head rn.

  • build a table of track references (currently anchors)

  • split the manual during rendering into mutliple output pages (and where each reference is located)

  • make sure the references point to the correct subpage in output

  • write a client side redirect script for people having the old references

getpsyched is currently working exactly on this under my supervision. It will take a while to get there, the devil is in the details.
09:15:49
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.host fricklerhandwerk:
Another thing that i'd like to get rid of are these include blocks in the nixpkgs/nixos docs. Because the overall structure can only be perceived from a recursive parser but not from a human. Which makes structural maintance/changes hard to understand.
09:29:38
@johannes.kirschbauer:scs.ems.host@johannes.kirschbauer:scs.ems.hostJust asking if i this would hit some right spot.09:30:42
@getpsyched:matrix.orggetpsyched
In reply to@phanirithvij:matrix.org
has anything been done for rendering docs in multiple pages since this discussion?
Hi, I've been working on the render docs as part of splitting the manuals into multiple pages. Currently the work is on getting a robust redirect system set up. As @Johannes Kirschbauer @hsjobeki outlined, I'm working on the same things and have pieced out the details in a roadmap which I'll convert into a formal documentation page after we hit the redirects milestone.

Feel free to track the progress through this diff:
https://github.com/NixOS/nixpkgs/compare/nixos-24.05...GetPsyched:nixpkgs:render-docs

The base branch is set to 24.05 as we're aiming to backport these changes there and jump to master/24.11 and run our script again to retro-actively catch breakages.
11:42:18
@terru:raccoon.college@terru:raccoon.college left the room.12:34:49
@ckie:ckie.devmei 🌒& changed their profile picture.23:25:17
26 Sep 2024
@fabianhjr:matrix.orgFabián Heredia set a profile picture.01:15:49
27 Sep 2024
@zardian:matrix.org@zardian:matrix.org left the room.14:03:08
@phanirithvij:matrix.orgloudgolem changed their display name from phanirithvij to loudgolem.14:38:01

Show newer messages


Back to Room ListRoom Version: 6