docs: Update --help output to reflect new command pattern#26
Open
swinney wants to merge 1 commit into
Open
Conversation
- Add comprehensive documentation of new command pattern vs legacy flags - Include all command aliases (g, gen, r, std, s, lm, lp, clean, etc.) - Clearly mark recommended approach (new commands) vs legacy support - Update examples to show both patterns for user clarity - Enhance main() function to recognize all command aliases - Maintain full backward compatibility with legacy flag-based CLI The help output now properly reflects the Phase 2 CLI refactoring that introduced the command pattern architecture while maintaining backward compatibility.
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.
Summary
Updates the CLI help output to accurately reflect the current state of the project after the Phase 2 refactoring, which introduced a command pattern architecture while maintaining backward compatibility.
Changes
Key Improvements
Testing
doc-gen --helpshows updated outputdoc-gen g --helpfor generate)Backward Compatibility
✅ All legacy flag-based commands continue to work exactly as before
✅ No breaking changes - purely additive improvements to help documentation
This addresses the user's request to update the out-of-date help output to reflect current capabilities.