Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write documentation only once #27

Open
Reokodoku opened this issue May 14, 2024 · 3 comments
Open

Write documentation only once #27

Reokodoku opened this issue May 14, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@Reokodoku
Copy link
Contributor

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
Copy link
Owner

Arnau478 commented May 14, 2024

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
Copy link
Contributor Author

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.

@Reokodoku Reokodoku changed the title GH workflow for man to html Write documentation only once May 14, 2024
@Arnau478
Copy link
Owner

Yeah, that's something to consider...

@Arnau478 Arnau478 added the documentation Improvements or additions to documentation label May 14, 2024
@Arnau478 Arnau478 added the help wanted Extra attention is needed label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants