mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-10-11 22:14:17 +00:00
Andoni A.
e4268b9893
Reorganize the image provider documentation to follow the same structure as the IaC provider doc. Add "How It Works" section, flatten hierarchy, fix undefined acronyms (OCI), add bold headers to bullet points, use Tabs for install methods, remove redundant sections, rename headers for SEO, and fix passive voice.
Prowler Documentation
This repository contains the Prowler Open Source documentation powered by Mintlify.
Documentation Structure
- Getting Started: Overview, installation, and basic usage guides
- User Guide: Comprehensive guides for Prowler App, CLI, providers, and compliance
- Developer Guide: Technical documentation for developers contributing to Prowler
Local Development
Install the Mintlify CLI to preview documentation changes locally:
npm i -g mint
Run the following command at the root of your documentation (where mint.json is located):
mint dev
View your local preview at http://localhost:3000.
Publishing Changes
Changes pushed to the main branch are automatically deployed to production through Mintlify's GitHub integration.
Documentation Guidelines
When contributing to the documentation, please follow the Prowler documentation style guide located in the .claude directory.
Troubleshooting
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
mint.jsonfile and that the page path is correctly listed in the navigation.