lilith/tldr
1
0
Fork 0
mirror of https://github.com/tldr-pages/tldr.git synced 2025-07-24 18:15:25 +02:00
Code Activity

style-guide: improve more info link instructions (#17155)

Browse source
This commit is contained in:
Managor 2025-07-07 17:26:07 +03:00 • committed by GitHub
parent c4c8e48869
commit 304d148972
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -337,9 +337,9 @@ It should instead be simplified to make it easier for everyone to read:
### 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
- On the `More information` link line, provide a direct link to documentation that instructs on how to use the command. We prefer linking to the author's provided documentation but when not available or very lacking in information, use <https://manned.org> as the default fallback for all platforms
(except `osx` and BSD platforms other than FreeBSD).
Alternatively, you can link to the author's website or a tutorial page if the command doesn't have a documentation page.
If there is no documentation page to be found, you can link to the author's website or a third party tutorial.
- For `osx`: Apple distributes the built-in man pages [in Xcode](https://developer.apple.com/documentation/os/reading_unix_manual_pages).
For commands documented there, we recommend using <https://keith.github.io/xcode-man-pages/>, an HTML export of all Apple's man pages bundled with Xcode.