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

feat: make web versions of man page more easily discoverable #967

Closed
CouldBeThis opened this issue May 6, 2024 · 1 comment
Closed

feat: make web versions of man page more easily discoverable #967

CouldBeThis opened this issue May 6, 2024 · 1 comment

Comments

@CouldBeThis
Copy link
Contributor

#471 was resolved and now there is a man page shipping with eza. However, that will take time to percolate out to various distribution channels. Most are a few version behind on eza and some still only have exa. Additionally, sometimes the web is preferable to terminal help. The man pages are tucked away in the repo and not easily findable.

A link to https://github.com/eza-community/eza/tree/main/man could be added to

  • this repo's readme.md
  • eza.rocks website
    • Probably just having the whole man pages on the website would be best; if there is some way to automatically update with the release?

It also occurs to me that given the fast development of eza and the lag of distribution via package managers, it might make sense to assist users in identifying their version and send them to the appropriate documentation. I see you can browse the man directory by tags. Would that be a realiable way to do it?

CouldBeThis added a commit to CouldBeThis/eza that referenced this issue May 6, 2024
…fixes eza-community#967

Signed-off-by: CouldBeThis <53547181+CouldBeThis@users.noreply.github.com>
@cafkafk
Copy link
Member

cafkafk commented May 6, 2024

I'd certainly be willing to look more into this when I have time (re: the website). PRs that link to the man pages in the readme are very welcome in the meanwhile, not sure what the best way to do versions is, but maybe by tags for now?.

@cafkafk cafkafk closed this as completed in 01a9c2a May 6, 2024
tertsdiepraam pushed a commit to tertsdiepraam/eza that referenced this issue Oct 10, 2024
…fixes eza-community#967

Signed-off-by: CouldBeThis <53547181+CouldBeThis@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants