lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-04-22 00:22:09 +02:00
Code Activity

style-guide: add grouping documentation (#15773)

Browse source 
Co-authored-by: Juri Dispan <juri.dispan@posteo.net>
This commit is contained in:
Managor 2025-03-01 22:28:36 +02:00 • committed by GitHub
parent 0b8c0bd452
commit 59e238fb5b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
contributing-guides/style-guide.md
View file

@ -226,6 +226,22 @@ In the following case `just.md` is the filename of the disambiguation page while
`tldr just.js`
```
### Grouping commands
Sometimes commands are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page.
For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally, `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example:
```md
# adb disconnect
> This command has been moved to `adb connect`.
- View documentation for `adb disconnect`:
`tldr adb connect`
```
## General writing
### Emphasis