Skip to main content

Contributing to Conviso Docs

To contribute to Conviso Docs, you must follow the Documentation Writing Best Practices guide.

Quick Start​

  1. Fork the repository.
  2. Edit a file inside docs/.
  3. Commit your change to your fork.
  4. Open a pull request to convisoappsec/conviso-docs:main.
  5. Wait for review and feedback.

Prerequisites​

  • A GitHub account.
  • Basic Markdown/MDX editing.

Optional:

Contribution Flows​

Flow A: Edit directly on GitHub (fastest)​

  1. Open the page source file in your fork under docs/.
  2. Click the edit button.
  3. Make your change in Markdown/MDX.
  4. Use Preview to verify rendering.
  5. Commit with a clear title and description.
  6. Open a pull request against main.

Flow B: Edit locally​

  1. Clone your fork.
  2. Run yarn install.
  3. Start docs locally with yarn start.
  4. Edit files in docs/.
  5. Validate the page locally.
  6. Commit, push, and open a pull request.

Pull Request Checklist​

Before opening your PR, confirm:

  • The page content is accurate and clear.
  • Markdown/MDX renders correctly.
  • Links and images work.
  • Title and description explain the change.
  • Scope is limited to the intended documentation update.

Standardized Screenshots (Required)​

Install the screenshot runtime once:

  1. Install browser runtime:
yarn screenshot:install

For screenshot execution and standards, follow: Documentation Writing Best Practices

Detailed Visual Guide​

If you prefer a step-by-step visual walkthrough, use the screenshots below.

Repository and Fork​

Repository page

Fork button

Create fork

Fork created

Edit and Commit​

Open file in edit mode

Markdown content

Preview changes

Commit changes

Pull Request​

Pull requests tab

New pull request

Compare across forks

Select repositories and branches

Compare changes

Create pull request form

Support​

If you need help, contact support@convisoappsec.com.

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute

Resources

By exploring our content, you'll find resources that will enhance your understanding of the importance of a Security Application Program.

Conviso Blog: Explore our blog, which offers a collection of articles and posts covering a wide range of AppSec topics. The content on the blog is primarily in English.

Conviso's YouTube Channel: Access a wealth of informative videos covering various topics related to AppSec. Please note that the content is primarily in Portuguese.