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.

Sign up for GitHub

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

Jump to bottom

Improve man pages #18

Open

hudson-newey opened this issue Dec 28, 2024 · 0 comments

Labels

Owner

hudson-newey commented Dec 28, 2024

At the moment I generate the man pages from the README.md file.

This is fine, but is not optimal because man pages typically have a different layout, and copy style to readme docs.

I should have a look around for some more professional/robust ways of generating man pages

After a quick skim, git looks like they have a pretty tried and tested way of generating man pages

https://github.com/git/git/tree/master/Documentation

hudson-newey added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment