feat: add support for user-doc-based help routing and manifest generation#6884
Open
robertolopezlopez wants to merge 1 commit into
Open
feat: add support for user-doc-based help routing and manifest generation#6884robertolopezlopez wants to merge 1 commit into
robertolopezlopez wants to merge 1 commit into
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
393fea9 to
84cb6cd
Compare
This comment has been minimized.
This comment has been minimized.
84cb6cd to
6585a70
Compare
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
0d3b9c3 to
636428d
Compare
PR Reviewer Guide 🔍
|
Contributor
Author
|
/describe |
|
PR Description updated to latest commit (636428d) |
Contributor
Author
|
/describe |
|
PR Description updated to latest commit (636428d) |
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.
User description
Pull Request Submission Checklist
are release-note ready, emphasizing
what was changed, not how.
What does this PR do?
Shows help generated by Cobra for CLI commands which don't have any GitBook help - existing GitBook help remains as source of truth.
Where should the reviewer start?
How should this be manually tested?
What's the product update that needs to be communicated to CLI users?
PR Type
Enhancement
Description
Prioritize user-documented help commands.
Fallback to Cobra's default help.
Generate manifest for user documentation.
Added comprehensive test coverage.
Diagram Walkthrough
flowchart LR A["CLI Help Invocation"] --> B{"Check User Docs"}; B -- Yes --> C["Legacy Help Mechanism"]; B -- No --> D["Resolve Cobra Target"]; D --> E["Render Cobra Help"]; F["Makefile: Generate Manifest"] --> G["helpdocs/manifest.txt"]; G --> B;File Walkthrough
4 files
Implements core logic for user-doc help routing.Integrates new help routing into CLI execution.Provides user-doc lookup and filename generation.Adds manifest generation and updates build/test.3 files
Adds tests for new help routing logic.Adds tests for help routing utilities.Tests user-doc manifest lookup logic.1 files
Lists available user-documented help files.