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

style-guide: add disambiguation page documentation (#15749)

Browse source
This commit is contained in:
Managor 2025-02-22 18:04:08 +02:00 • committed by GitHub
parent 3239c4b7bb
commit 10337fbb6c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -206,6 +206,26 @@ In this case, provide a note and method to determine whether the command current
`tldr invoke-webrequest`
```
### Disambiguations
If there is a name collision between page names on the same platform, disambiguation pages can be used to direct users to different pages. Name the colliding pages with a dot and an appropriate suffix. Numbers starting from 1 can be used if no other suffix is appropriate. If the colliding page is an acronym, direct the user to a page with the name expanded.
In the following case `just.md` is the filename of the disambiguation page while `just.1.md` and `just.js.md` refer to the actual pages:
```md
# just
> `just` can refer to multiple commands with the same name.
- View documentation for the command runner:
`tldr just.1`
- View documentation for the V8 JavaScript runtime:
`tldr just.js`
```
## General writing
### Emphasis