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

In reply to @phanirithvij:matrix.org
@johannes.kirschbauer:scs.ems.host is there a noogle matrix channel?

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

In reply to@phanirithvij:matrix.org
has anything been done for rendering docs in multiple pages since this discussion?

Hello community,

Is there a kind of roadmap for the documentation?

Or a place that is the most in need of updating?

Kind regards

There is no simple answer for this. The answer will be different depending who you ask, and what scope you set.

My personal answer would be:

The documentation - especially the handbooks for nix/nixpkgs and the documentation in search.nixos.org for packages/options and installation and usage procedures are good enough for people who like to read and write code to get a sufficiant understanding of nix and the ecosystem.

In my personal view the documentation is lacking for the „non-coder/linux users but also administrators“ und NixOS - and there https://wiki.nixos.org needs some low level documentation and there are some low hanging fruits, what can be done to improve the situation (documentation about desktop programs and their configuration via simple configuration.nix commands. If you just use your desktop for (office) work and have some small scale servers (maybe a VM-Host and some VMs on it), you may not need Flakes, Homemanager, a deep understanding of nix language, the ability to package for nixpkgs, setup Hydra, do remote builds, have a complex configuration system etc.
But these users need more information about typical desktop and server programs, how to configure it (with full and explained examples), maybe to setup the servers (how to setup an hedgedoc instance for myself and make it safe with .htaccess authentification), or „how to install firefox including some common plugins and some privacy configuration“.

The long-term goal would be: Find a way to include these examples and better documentation for options in nixpkgs itself, in a way that it can be autogenerated in manuals and included in the search results from sites like search.nixos.org.