Write documentation only once #27

Reokodoku commented 2024年05月14日 10:22:27 +02:00 (Migrated from github.com)

I think it is a good idea to serve a GitHub pages site with HTML pages generated from man pages. Now for documentation we have to write it twice: once in markdown and once in man.

If we serve the man pages we can write less documentation.

I think it is a good idea to serve a GitHub pages site with HTML pages generated from man pages. Now for documentation we have to write it twice: once in markdown and once in man. If we serve the man pages we can write less documentation.

Arnau478 commented 2024年05月14日 11:41:53 +02:00 (Migrated from github.com)

That's interesting. I was considering creating a whole page, and have the current one be something like /lib. Then, we could have /docs which would be the documentation of the program itself.

The only problem I see when unifying the documentation is that the manpage format is not the ideal one for web documentation. I would prefer something like https://docusaurus.io or GitBook

That's interesting. I was considering creating a whole page, and have the current one be something like `/lib`. Then, we could have `/docs` which would be the documentation of the program itself. The only problem I see when unifying the documentation is that the manpage format is not the ideal one for web documentation. I would prefer something like <https://docusaurus.io> or GitBook

Reokodoku commented 2024年05月14日 14:49:59 +02:00 (Migrated from github.com)

Maybe we can write the documentation in markdown (so we can use it with x site) and then convert it to manpages with tools like ronn, but I think that in this way the markdown file layout will be forced.

Maybe we can write the documentation in markdown (so we can use it with `x` site) and then convert it to manpages with tools like `ronn`, but I think that in this way the markdown file layout will be forced.

Arnau478 commented 2024年05月14日 15:13:28 +02:00 (Migrated from github.com)

Yeah, that's something to consider...

Yeah, that's something to consider...