From 59e238fb5b9f531975552fecfda100a54af47086 Mon Sep 17 00:00:00 2001 From: Managor <42655600+Managor@users.noreply.github.com> Date: Sat, 1 Mar 2025 22:28:36 +0200 Subject: [PATCH] style-guide: add grouping documentation (#15773) Co-authored-by: Juri Dispan --- contributing-guides/style-guide.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/contributing-guides/style-guide.md b/contributing-guides/style-guide.md index 05ea7d2634..e655ba9240 100644 --- a/contributing-guides/style-guide.md +++ b/contributing-guides/style-guide.md @@ -226,6 +226,22 @@ In the following case `just.md` is the filename of the disambiguation page while `tldr just.js` ``` +### Grouping commands + +Sometimes commands are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page. + +For example `adb disconnect` has a single way using it, but `adb` is expansive enough that it doesn't fit in the main page. Normally, `adb disconnect` is used in combination with `adb pair` and `adb connect`, thus it makes sense to group these together into a single page. For example: + +```md +# adb disconnect + +> This command has been moved to `adb connect`. + +- View documentation for `adb disconnect`: + +`tldr adb connect` +``` + ## General writing ### Emphasis