From c7868a7c9cce3c555aa004cde8b493941701ee47 Mon Sep 17 00:00:00 2001 From: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com> Date: Mon, 22 Jan 2024 01:13:24 -0300 Subject: [PATCH] style-guide: recommend keith.github.io for osx pages (#12097) * style-guide: recommend keith.github.io for osx pages --------- Co-authored-by: K.B.Dharun Krishna --- contributing-guides/style-guide.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index d4dacf0c1..27207010d 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -373,6 +373,8 @@ This can be resolved by inserting a comma before the "and" or "or" in the final - 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 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. +- 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. + - **All links must be enclosed inside angular brackets (`<` and `>`) for proper rendering in clients.** - We prefer translations to use the more information link of the English page by default.