DawnMagnet/tldr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

mention subcommands in every base page (#6383)

Browse Source
This commit is contained in:
marchersimon
2021-09-13 10:21:21 +02:00
committed by GitHub
parent 4fbb601f63
commit bd677b8b48
63 changed files with 69 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.md
View File

@@ -75,7 +75,8 @@ Many programs use subcommands for separating functionality, which may require th
For instance, `git commit` has its own page, as well as `git push` and many others.
To create a page for a subcommand, the program and subcommand need to be separated with a dash (`-`), so `git-commit.md` is shown when calling `tldr git commit`.
You should always add a base page (e.g. `git`) that describes the program and basic switches like `--version` or `help`.
You should always add a base page (e.g. `git`) that describes the program and basic switches like `--version` or `--help`.
To let users know about the subcommand, add a note saying ``Some subcommands such as `example command` have their own usage documentation`` to the base page.
See these examples for reference:
* [git](pages/common/git.md)