Conversation
… docs/commands.md Agent-Logs-Url: https://github.com/OpenForgeProject/mageforge/sessions/df856e85-1c15-4a26-93d0-d8561e9c69ac Co-authored-by: dermatz <6103201+dermatz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix duplicate numbering and add missing sections in commands documentation
docs: Fix commands.md numbering, missing sections, and flag inconsistencies
Apr 16, 2026
dermatz
approved these changes
Apr 16, 2026
Merged
Contributor
There was a problem hiding this comment.
Pull request overview
Updates docs/commands.md to improve the accuracy and consistency of MageForge CLI command documentation (numbering, sections, and option descriptions).
Changes:
- Renumbered command headings to remove duplicate numbering and keep a sequential list.
- Added dedicated Aliases blocks for
mageforge:theme:buildandmageforge:theme:watch, and added an Options block formageforge:theme:watch. - Updated
mageforge:versiondocumentation with acomposer.lockrequirement note and removed a misleading compatibility-check option entry / markdown escape artifact.
|
|
||
| - `--show-all` / `-a` - Show all modules including compatible ones | ||
| - `--third-party-only` / `-t` - Check only third-party modules (exclude Magento\_\* modules) | ||
| - `--include-vendor` - Include Magento core modules in scan (default: third-party only) |
Comment on lines
+95
to
+98
| **Options**: | ||
|
|
||
| - `--theme=THEME` - Theme code in format `Vendor/theme` to watch | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/commands.mdhad a duplicate### 5.heading, missingAliases/Optionssections on two commands, a misleading option entry, a markdown escape artifact, and an undocumented runtime requirement.Changes
VersionCommand→ 6,CompatibilityCheckCommand→ 7,TokensCommand→ 8,InspectorCommand→ 9frontend:buildandfrontend:watchfrom prose in Implementation Details to dedicated**Aliases**blocks (consistent withCompatibilityCheckCommand/TokensCommand)ThemeWatchCommand: Add--theme=THEMEdescription block, matching the pattern used by other commands--third-party-only/-t: Option was listed but third-party-only is the default;--include-vendoris the actual toggle — the phantom flag entry is removedMagento_*rendering: Remove stray backslash escape (Magento\_\*→Magento_*)composer.locknote inVersionCommand: Add a callout that the command requirescomposer.lockto be present to resolve the current installed versionOriginal prompt
Problem
The file
docs/commands.mdcontains several issues that need to be fixed:1. 🔴 Duplicate numbering (two "### 5.")
Both
SystemCheckCommandandVersionCommandare labeled as "### 5.". Fix the numbering so all commands are sequentially numbered:2. 🟡 Missing Aliases sections for
BuildThemeCommandandThemeWatchCommandBoth commands have aliases mentioned only inside "Implementation Details". Add a dedicated Aliases section (like
CompatibilityCheckCommandandTokensCommandhave) for consistency:BuildThemeCommand→ alias:frontend:buildThemeWatchCommand→ alias:frontend:watch3. 🟡 Missing Options section for
ThemeWatchCommandThe
--theme=THEMEoption is only shown in the usage line but not described in a dedicated Options section. Add one for consistency with other commands.4. 🟡 Inconsistency with
--third-party-only/-tflag inCompatibilityCheckCommandThe options section lists
--third-party-only/-tas an option, but the Default Behavior section states that third-party-only scanning is the default behavior. The flag--include-vendoris the actual toggle. Clarify or remove the misleading--third-party-onlyoption entry if it is redundant/non-existent.5. 🟢
Magento\_\*escape rendering artifactOn line with
--third-party-onlydescription,Magento\_\*renders with a visible backslash in markdown. Change toMagento_*.6. 🟢 Add a note about
composer.lockrequirement inVersionCommandThe implementation reads from
composer.lock, but this file may not always be present. Add a brief note/requirement about this.File to change
docs/commands.mdThe following is the prior conversation context from the user's chat exploration (may be truncated):
User: /review
Assistant: Here's a thorough review of
docs/commands.md:✅ Overall Assessment
The documentation is well-structured, thorough, and developer-friendly. Commands are consistently formatted with Purpose, File, Dependencies, Usage, and Implementation Details. A few issues worth fixing are noted below.
🐛 Issues Found
1. Duplicate numbering — Commands 5 & 5
Both
SystemCheckCommandandVersionCommandare labeled as "### 5." TheVersionCommandshould be "### 6.", and all subsequent commands need to be renumbered accordingly.2. Incorrect
--third-party-only/-tflag description (CompatibilityCheckCommand)The options section (line 214) lists
--third-party-only/-t, but the Default Behavior section explicitly states third-party-only is the default. This option either doesn't exist or is misleading. If it's the default, this flag may be redundant/removed — the actual differentiating flag is--include-vendor. This should be clarified or the option removed if it no longer exists.3. Inconsistency:
mageforge:theme:watchoption nameThe usage shows:
bin/magento mageforge:theme:watch [--theme=THEME]But the implementation details say "If no theme code is provided, displays an interactive prompt" — this is fine, but the option
--themeis not described in an Options section like other commands (e.g.,CompatibilityCheckCommand). Consider adding a small Options block for consistency.4.
CleanCommandpath discrepancyThe Purpose line (line 100) mentions
var/view_preprocessed,pub/static,var/page_cache,var/tmp, andgenerated. The Implementation Details section lists these same directories but omitsvar/view_preprocessed/source/...from the purpose summary. Minor, but the purpose blurb could be updated to mention bothview_preprocessedsubdirectories, or the detail section could be considered the authoritative list.5.
VersionCommandreads fromcomposer.lock— potentially fragileLine 184 states it reads the current version from
composer.lock. This is worth a documentation note sincecomposer.lockmay not always be present (e.g., in development setups where it's gitignored or in some CI environments). A brief note about this requirement would improve the docs.💡 Minor Suggestions
Magento\_\*renders with a visible backslash escape in markdown. It should beMagento_*(no backslash needed in a plain list item, only in table cells or when escaping is needed).MagentoStandard\Buildernote (lines 475–479) is detailed but indented under builder services; t...This pull request was created from Copilot chat.