Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

style-guide: add grouping documentation #15773

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Managor
Copy link
Collaborator

@Managor Managor commented Feb 22, 2025

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added the documentation Issues/PRs modifying the documentation. label Feb 22, 2025
@Managor
Copy link
Collaborator Author

Managor commented Feb 22, 2025

I'm asking for feedback if this should be documented.

Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that it makes sense to document this


Sometimes commands and subcommands are single use but 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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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:
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:

@@ -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 and subcommands are single use but are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Sometimes commands and subcommands are single use but are meant to be used in combination with other commands. In these cases it makes sense to move them on the same page.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues/PRs modifying the documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants