Put organization commands into general commands#7165
Conversation
|
We detected some changes at Caution DO NOT create changesets for features which you do not wish to be included in the public changelog of the next CLI release. |
7f2b445 to
1a0173f
Compare
69beb9d to
015aae8
Compare
015aae8 to
15545ea
Compare
There was a problem hiding this comment.
Pull request overview
Moves Shopify CLI “organization” commands out of their own documentation category and into the “general commands” bucket so they’re grouped with other cross-cutting CLI commands.
Changes:
- Treat the
organizationtopic as part ofgeneralTopicsduring docs generation. - Regenerate docs artifacts so
organization listis categorized under “general commands”. - Remove the standalone “organization” category page/template from the docs site.
Reviewed changes
Copilot reviewed 3 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| packages/cli/src/cli/commands/docs/generate.ts | Adds organization to the topics that should be categorized as “general commands” during doc generation. |
| docs-shopify.dev/generated/generated_docs_data.json | Updates generated docs data to reflect the new “general commands” category. |
| docs-shopify.dev/generated/generated_category_pages.json | Removes the generated “organization” category page entry. |
| docs-shopify.dev/commands/organization-list.doc.ts | Updates the command doc’s category to “general commands”. |
| docs-shopify.dev/categories/organization.doc.ts | Removes the now-unused category template for “organization”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| // Topics that are included in the general commands category | ||
| const generalTopics: string[] = ['config', 'auth'] | ||
| const generalTopics: string[] = ['config', 'auth', 'organization'] |
There was a problem hiding this comment.
The categorization behavior here (treating organization as a general topic) isn’t covered by the existing unit tests for the docs generator. Please add a test case that verifies writeCommandDocumentation assigns category: 'general commands' when hasTopic is true and topic is one of generalTopics (e.g., an organization:... command). This will prevent regressions if the topic list or category logic changes later.

WHY are these changes introduced?
Fixes #0000
WHAT is this pull request doing?
How to test your changes?
Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist