Skip to content

Commit 5bcd908

Browse files
Managorkbdharun
andauthored
style-guide: add instructions to shorten the link (#17585)
Co-authored-by: K.B.Dharun Krishna <[email protected]>
1 parent fdd6d7b commit 5bcd908

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

contributing-guides/style-guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,7 @@ It should instead be simplified to make it easier for everyone to read:
350350
- 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
351351
(except `osx` and BSD platforms other than FreeBSD).
352352
If there is no documentation page to be found, you can link to the author's website or a third party tutorial.
353+
- Keep the more information link short. Cut out redundant text if possible. For example use https://manned.org/partclone instead of https://manned.org/man/partclone.8 unless there are two different manpages for a command across distributions/platforms i.e. `command.1` and `command.8`.
353354

354355
- For `osx`: Apple distributes the built-in man pages [in Xcode](https://developer.apple.com/documentation/os/reading_unix_manual_pages).
355356
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.

0 commit comments

Comments
 (0)