From a9f7c8fcba896a63a5a248b1b756836d760e5c81 Mon Sep 17 00:00:00 2001 From: Vitor Henrique <87824454+vitorhcl@users.noreply.github.com> Date: Sun, 31 Dec 2023 09:57:47 -0300 Subject: [PATCH] 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 --- contributing-guides/style-guide.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index c2300a34b..03405360e 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -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 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.