feat(docs): Improve command documentation generation script

[ritwik-g]

User description

Description

This PR improves the command documentation generation script to make it more maintainable and accurate.

Changes Made

• Refactored script into modular functions with clear responsibilities
• Added comprehensive docstrings and type hints for better maintainability
• Fixed option name display to show both long and short forms correctly
• Added proper handling of hidden options
• Improved code organization and error handling

Testing Done

• Ran the script locally to verify documentation generation
• Verified that all command options are correctly documented
• Confirmed that hidden options are properly excluded

Related Issues

• Improves documentation generation for all CLI commands
• Makes the documentation more accurate and maintainable

Checklist

• Code follows project's coding standards
• Documentation has been updated
• Changes have been tested locally
• No breaking changes introduced

---

PR Type

Enhancement, Documentation

---

Description

• Added a script to generate CLI command documentation.

• Introduced a GitHub workflow to automate documentation updates.

• Removed outdated README content to streamline documentation.

---

Changes walkthrough 📝

	Relevant files
Enhancement	generate_docs.py Added script for CLI command documentation generation        .github/workflows/generate_docs.py Added a script to generate markdown documentation for CLI commands. Utilized Typer library for command introspection and documentation generation. Included handling for hidden options and default values. Organized code into modular functions for maintainability. +196/-0
Configuration changes	update-docs.yml Added workflow for automated documentation updates              .github/workflows/update-docs.yml Added a GitHub workflow to update command documentation. Configured triggers for pushes and pull requests affecting CLI files. Automated documentation generation and PR creation for main branch updates. +80/-0
Documentation	README.md Removed outdated README content                                                    README.md Removed outdated content related to Helm Values Manager. Streamlined documentation to focus on updated workflows. +0/-194
Additional files	README.md [link]

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Error Handling The script lacks error handling for file operations and command introspection. Consider adding try-except blocks to handle potential exceptions when accessing command attributes or writing to files. if __name__ == "__main__": docs = generate_markdown_docs() with open("docs/Commands/README.md", "w") as f: f.write(docs) Branch Protection The workflow has write permissions to all branches and could potentially overwrite protected branches. Consider adding branch protection rules and restricting the workflow permissions. permissions: contents: write pull-requests: write

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
Possible issue	Add error handling for files Add error handling around file operations to gracefully handle permission issues or missing directories when writing documentation. .github/workflows/generate_docs.py [193-196] if __name__ == "__main__": docs = generate_markdown_docs() - with open("docs/Commands/README.md", "w") as f: - f.write(docs) + try: + os.makedirs(os.path.dirname("docs/Commands/README.md"), exist_ok=True) + with open("docs/Commands/README.md", "w") as f: + f.write(docs) + except OSError as e: + print(f"Error writing documentation file: {e}") + sys.exit(1) Apply this suggestion Suggestion importance[1-10]: 7 __ Why: The suggestion adds important error handling for file operations, including directory creation and proper error reporting, which would prevent silent failures and improve debugging capabilities.	Medium
General	Add workflow timeout protection Add a timeout to the workflow to prevent hanging in case of issues with documentation generation or git operations. .github/workflows/update-docs.yml [15-20] jobs: update-docs: runs-on: ubuntu-latest + timeout-minutes: 10 permissions: contents: write pull-requests: write Apply this suggestion Suggestion importance[1-10]: 6 __ Why: Adding a timeout limit is a good practice to prevent workflow runs from hanging indefinitely, which could waste GitHub Actions minutes and delay other workflows.	Low
More

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud