Better navigation of nixos.org manuals

That’s wonderful. Great to hear!

Is there a link to a repo with the current state? Or any known blockers / things that were hard?

All work in progress had been merged, but we only got to ensuring that URLs won’t break in principle (see redirects.json). The hard part was, and still is, wiring it just the right way such that swapping the default to the split version will redirect users to the right new page, while retaining consistency of the single-page rendering for those who want to keep using that. The task is up for grabs to finish, and probably @GetPsyched can share some more insights.

1 Like

Yup.

There were some concerns on having a multi-page doc since it harms the ability to ctrl-f through the manual, which is bad without a good search integration. A consensus we reached on, IIRC, was to retain the single-page manual, while having a split view for those who prefer it, as well as better SEO.

It’s just a matter of coordinating and spending time on this to get it over the finish line.


On another note, there have been recent efforts to reduce the bulkiness of the single-page manual (tracking).

1 Like

@fricklerhandwerk given what you wrote in the multi-page thread:

It seems like it’d still be beneficial to improve the experience in the single-page version. I think something like @samueldr’s scroll-matching ToC sidebar would be ideal. Is that improvement something the documentation team would be open to for the single-page versions of the manuals? If so, is there anything I could do to help make that happen?

3 Likes

@samestep

If you’d be open for making a PR I’d be happy to review and merge it

PR doesn’t need to be perfect from the beginning, something like what @lurenjiasworld showed would already be a great improvement for navigation. We discussed similar quick wins today in the documentation meeting.

1 Like