Skip to content

feat: add support for user-doc-based help routing and manifest generation#6884

Open
robertolopezlopez wants to merge 1 commit into
mainfrom
feat/CLI-1474
Open

feat: add support for user-doc-based help routing and manifest generation#6884
robertolopezlopez wants to merge 1 commit into
mainfrom
feat/CLI-1474

Conversation

@robertolopezlopez
Copy link
Copy Markdown
Contributor

@robertolopezlopez robertolopezlopez commented Jun 5, 2026

User description

Pull Request Submission Checklist

  • Follows CONTRIBUTING guidelines
  • Commit messages
    are release-note ready, emphasizing
    what was changed, not how.
  • Includes detailed description of changes
  • Contains risk assessment (Low | Medium | High)
  • Highlights breaking API changes (if applicable)
  • Links to automated tests covering new functionality
  • Includes manual testing instructions (if necessary)
  • Updates relevant GitBook documentation (PR link: ___)
  • Includes product update to be announced in the next stable release notes

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;
Loading

File Walkthrough

Relevant files
Enhancement
4 files
help_routing.go
Implements core logic for user-doc help routing.                 
+171/-0 
main.go
Integrates new help routing into CLI execution.                   
+4/-12   
helpdocs.go
Provides user-doc lookup and filename generation.               
+55/-0   
Makefile
Adds manifest generation and updates build/test.                 
+15/-2   
Tests
3 files
help_routing_test.go
Adds tests for new help routing logic.                                     
+178/-0 
main_test.go
Adds tests for help routing utilities.                                     
+114/-0 
helpdocs_test.go
Tests user-doc manifest lookup logic.                                       
+94/-0   
Documentation
1 files
manifest.txt
Lists available user-documented help files.                           
+32/-0   

@robertolopezlopez robertolopezlopez self-assigned this Jun 5, 2026
@snyk-io
Copy link
Copy Markdown

snyk-io Bot commented Jun 5, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@robertolopezlopez robertolopezlopez marked this pull request as ready for review June 5, 2026 13:47
@robertolopezlopez robertolopezlopez requested a review from a team as a code owner June 5, 2026 13:47
@snyk-pr-review-bot

This comment has been minimized.

@snyk-pr-review-bot

This comment has been minimized.

@snyk-pr-review-bot

This comment has been minimized.

@snyk-pr-review-bot
Copy link
Copy Markdown

PR Reviewer Guide 🔍

🧪 PR contains tests
🔒 No security concerns identified
⚡ No major issues detected
📚 Repository Context Analyzed

This review considered 21 relevant code sections from 13 files (average relevance: 0.94)

🤖 Repository instructions applied (from AGENTS.md)

@robertolopezlopez
Copy link
Copy Markdown
Contributor Author

/describe

@snyk-pr-review-bot
Copy link
Copy Markdown

PR Description updated to latest commit (636428d)

@robertolopezlopez
Copy link
Copy Markdown
Contributor Author

/describe

@snyk-pr-review-bot
Copy link
Copy Markdown

PR Description updated to latest commit (636428d)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant