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

doc (website): put man pages for ads-github-tools on the project's web site: https://salewski.github.io/ads-github-tools/ #35

Open
salewski opened this issue Jul 20, 2018 · 0 comments
Labels
area:documentation Improvements or additions to documentation

Comments

@salewski
Copy link
Owner

salewski commented Jul 20, 2018

It has happened twice this week that I went looking for the ads-github-tools man pages on the project's web site, but they weren't there:

    https://salewski.github.io/ads-github-tools/

It's not the end of the world since they're installed locally, but it was annoying both times to come up empty handed on the web. This isn't a call for web-only documentation (I generally find that to be a major PITA), but having them online would be useful for casual lookup when already in the browser. It would also make them available as targets for linking.

As a first cut it's probably good enough just to get them up on the site, similar to what is done for my screen-wrappers project:

    https://salewski.github.io/screen-wrappers/man/man1/screen-ls.1.html

Those are presentable, but to really do a first-rate job you would want them to look like Michael Kerrisk's from his Linux man-pages project. For example:

    http://man7.org/linux/man-pages/man1/troff.1.html
@salewski salewski added area:documentation Improvements or additions to documentation and removed documentation labels Oct 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant