ctome
/
tldr
mirror of https://github.com/CrimsonTome/tldr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

style-guide: add documentation for "See also" links (#11868) 

Co-authored-by: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com>
Co-authored-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
pull/23/head
Vitor Henrique 2023-12-31 09:57:47 -03:00 committed by GitHub
parent d04440612f
commit a9f7c8fcba
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
contributing-guides/style-guide.md
View File

@ -348,6 +348,23 @@ This can be resolved by inserting a comma before the "and" or "or" in the final
> Delete the Git branches, tags, and remotes.
## See also section
- To reference a related command or subcommand, use:
```md
> See also: `command`.
```
- To reference related commands or subcommands, use:
```md
> See also: `command1`, `command2`, `command3`.
```
- Optionally, you can add a short description beside the referenced pages:
``See also: `date`, for Unix information; `umount`, for unmounting partitions.``
## More information links
- On the `More information` link line, we prefer linking to the author's provided documentation of the command line reference or the man page. When not available, use <https://manned.org> as the default fallback for all platforms (except `osx` and some BSD platforms). Alternatively, you can link to the author's website or a tutorial page if the command doesn't have a documentation page.