Move documentation to mdBook

[arunoruto]

I just got into kanata using nixos and it works amazing!
The only problem I currently have, is the documentation is kinda all over the place in the docs file.
It would be cool to have it searchable with a sidebar!

There is mdBook, which is usually used for rust projects, so maybe one can start from there. And since it uses markdown under the hood, the current docs can be just ported there!

I have some experience using mkdocs and automating it using github pages, so if you need help or a proof of concept, git me up!

[jtroo]

For some initial context, the main doc intended for user consumption would be the configuration guide which is in asciidoc, not markdown. Reading the configuration guide on GitHub, I see a toggle for sidebar with all the headings already, with a filter for headings.

With the context above, what improvements would mdbook be providing?

[arunoruto]

Sorry, I forgot to respond.
The main benefit, I usually appreciate the most, is the search functionality. Sure, one can also search through the GitHub repository, but the algorithm is tailored more for code and not for text.
Linking between the articles is also possible (not sure if asciidoc can do that too).
And in the end, it is a bit nicer to the eyes. Mdbook is also widely used, so most people should be familiar with the layout by now.