Tldr: Let's document! GitHub CLI (gh)

Created on 15 Oct 2020  路  4Comments  路  Source: tldr-pages/tldr

I used the github client (gh) and I consult the tldr documentation and it is already very good, but I think we can improve a little bit this command documentation.

First, they're some little mistake on gh pr view and gh issue view, we can update the command to correspond to the description.

Moreover, we can create other examples to cover the entire github process from repo creation to release:

  • add an example to create a repo.
  • add an example to merge a PR.
  • add an example to create a release.
  • add an example to list all releases.

Finally, If it is ok I can propose a PR to make these changes.

After some discussions , it is better to create sub-pages for the gh command:

For those not in the know, tldr-pages is about more than just commands. Those commands that are too expansive to fit on 1 page often have multiple subcommands - which we can document on their own pages. For example, try these:

tldr git merge
tldr git add
tldr ip address

So, let's document gh, at least we need:

  • [ ] alias
  • [ ] api
  • [x] auth
  • [ ] completion
  • [x] config
  • [x] gist
  • [ ] help
  • [x] issue
  • [x] pr
  • [x] release
  • [x] repo
  • [ ] secret
help wanted new command

Most helpful comment

There are a few more gh subcommands not documented by tldr, and since this issue is relatively recent (Oct. 2020), I decided to edit it and reopen it.

All 4 comments

I think you should implement the same structure that the ticket #3953 to create pages for all the gh subcommands

After some discussions , it is better to create sub-pages for the gh command:

For those not in the know, tldr-pages is about more than just commands. Those commands that are too expansive to fit on 1 page often have multiple subcommands - which we can document on their own pages. For example, try these:

tldr git merge
tldr git add
tldr ip address

So, let's document gh, at least we need:

  • [x] gh auth
  • [x] gh config
  • [x] gh repo
  • [x] gh issue
  • [x] gh pr
  • [x] pr release
  • [x] gh gist

Cool, @antoine-amara! Perhaps you could update the original issue description with that list, to make it easier for people to find?

There are a few more gh subcommands not documented by tldr, and since this issue is relatively recent (Oct. 2020), I decided to edit it and reopen it.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Wesalius picture Wesalius  路  3Comments

waldyrious picture waldyrious  路  4Comments

mikerouxfr picture mikerouxfr  路  3Comments

waldyrious picture waldyrious  路  3Comments

amitech picture amitech  路  3Comments