mirror of
https://github.com/prowler-cloud/prowler.git
synced 2026-04-16 17:47:47 +00:00
43 lines
1.3 KiB
Plaintext
43 lines
1.3 KiB
Plaintext
---
|
|
title: 'Contributing to Documentation'
|
|
---
|
|
|
|
Prowler documentation is built using [Mintlify](https://www.mintlify.com/docs), allowing contributors to easily add or enhance documentation.
|
|
|
|
## Installation and Setup
|
|
|
|
<Steps>
|
|
<Step title="Install Mintlify CLI">
|
|
```bash
|
|
npm i -g mint
|
|
```
|
|
For detailed instructions, check the [Mintlify documentation](https://www.mintlify.com/docs/installation).
|
|
</Step>
|
|
|
|
<Step title="Preview Documentation Locally">
|
|
Start the local development server to preview changes in real-time.
|
|
|
|
```bash
|
|
mint dev
|
|
```
|
|
|
|
A local preview of your documentation will be available at http://localhost:3000
|
|
</Step>
|
|
|
|
<Step title="Make Documentation Changes">
|
|
Edit existing Markdown (.mdx) files inside the `docs` directory or add new documents.
|
|
|
|
For reference about formatting, check the [Mintlify documentation](https://www.mintlify.com/docs/create/text).
|
|
|
|
To add new sections or files, update the [`docs/docs.json`](https://github.com/prowler-cloud/prowler/blob/master/docs/docs.json) file to include them in the navigation.
|
|
</Step>
|
|
|
|
<Step title="Submit Changes">
|
|
Once documentation updates are complete, submit a pull request for review.
|
|
|
|
The Prowler team will assess and merge contributions.
|
|
</Step>
|
|
</Steps>
|
|
|
|
Your efforts help improve Prowler documentation—thank you for contributing!
|