orhun / orhun/halp

Incorporate documentation from tldr

Open
#2 6 comments 3 reactions 1 assignee View on GitHub

@orhun is already working on this.

Since Mar 12, 2023.

enhancement
Dominant language
Rust
Stars
769
Forks
14
Avg merge
1m
Merged PRs (30d)
5

Description

Using documentation

Great to use man pages, trying -h/--help, but there is also information at the tldr project that you could be tapping into: https://github.com/tldr-pages/tldr

Describe the solution you'd like

Next to the man page, offer a direct dive into the alternate documentation of tldr.

Describe alternatives you've considered

Just bypass halp and use tldr directly, but halp could be a one-stop solution, so people don't need to download tldr or the tldr archives themselves.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.