# vRODoc - vRO Documentation Generator

## Overview
vRODoc is a PowerShell-based tool that automatically generates comprehensive JSDoc documentation from VMware vRealize Orchestrator (vRO) packages. It simplifies the process of documenting vRO actions by creating a searchable HTML documentation site.

## Features
- 🚀 Automatic prerequisite checking and installation
- 🔐 Secure vRO authentication handling
- 📦 Package extraction and processing
- 📄 JSDoc-compatible documentation generation
- 🌐 Searchable HTML output
- ⚡ Support for both vRO 7.x and 8.x

## Prerequisites
- PowerShell 5.1 or higher
- Node.js
- JSDoc
- Write access to export directory
- Network access to vRO server
- Embedded vRO Setup only
- Works on Windows. Script not tested on Linux.

> The script can automatically install missing prerequisites if `autoFix` is enabled.

.\vroDoc.ps1 -vroHost "vro.company.com" `
             -vroPort "443" `
             -user "[email protected]" `
             -pass "yourpassword" `
             -exportPath "C:\Documentation" `
             -packageName "com.vmware.library.http-rest" `
             -autoFix $true `
             -skipChecks $false

exportPath/
└── vRODoc Files/
    ├── [Package_Name]/
        └── Actions/
        |   └── [Category]/
        |        └── action.js
        └── docs/
            └── index.html

• Create a package with all the custom actions.
• As script works for embedded vRO, fill all the parameter values either in script or while running the script.
• Wait for the script to successfully complete.
• In the export path, you will find a directory called "vRODoc Files"
• Open vRODoc Files > packageName folder (eg. com.vmware.utilities) > docs > index.html
• In your browser, a page will open up with all your actions in a beautiful JSdoc format.

• Automatic prerequisite validation
• Self-healing installation of dependencies
• Secure token-based authentication
• Comprehensive error handling
• Progress indicators
• Clean documentation output

Contributions are welcome! Please feel free to submit pull requests.

This project is licensed under the MIT License - see the LICENSE file for details.

• VMware vRealize Orchestrator team
• JSDoc community
• Node.js community

For issues, questions, or contributions, please open an issue in the GitHub repository.

Made with ❤️ for the vRO community