Skip to main content
Prowler documentation is built using Mintlify, allowing contributors to easily add or enhance documentation.

​
Documentation Structure

The Prowler documentation is organized into several sections. The main ones are:
  • Getting Started: Provides an overview of the Prowler platform and its different solutions, including Prowler Cloud/App, Prowler CLI, Prowler MCP Server, Prowler Hub, and Prowler Lighthouse AI. This section helps new users understand which Prowler solution best fits their needs and includes product comparisons.
  • Guides: Contains practical tutorials and how-to guides organized by product (Prowler Cloud/App, CLI) and provider (AWS, Azure, GCP, Kubernetes, Microsoft 365, GitHub, etc.). This section covers authentication, integrations, compliance, and advanced usage scenarios.
  • Developer Guide: Documentation for contributors looking to extend Prowler functionality. This includes guides on creating providers, services, checks, output formats, integrations, and compliance frameworks. Provider-specific implementation details and testing strategies are also covered here.
  • Troubleshooting: Common issues, error messages, and their solutions. This section helps users resolve problems encountered during installation, configuration, or execution.

​
AI-Driven Documentation

As mentioned in the Introduction, we have specialized resources to enhance AI-driven development. This includes the AGENTS.md file that contains the guidelines and style guide for the AI agents in the Prowler documentation.

​
Local Development

1

Install Mintlify CLI

npm i -g mint
For detailed instructions, check the Mintlify documentation.
2

Preview Documentation Locally

Start the local development server to preview changes in real-time.
mint dev
A local preview of your documentation will be available at http://localhost:3000
3

Make Documentation Changes

Edit existing Markdown (.mdx) files inside the docs directory or add new documents.For reference about formatting, check the Mintlify documentation.To add new sections or files, update the docs/docs.json file to include them in the navigation.
4

Submit Changes

Once documentation updates are complete, submit a pull request for review.The Prowler team will assess and merge contributions.
Your efforts help improve Prowler documentation. Thank you for contributing! 🤘