Contributing

Wanna help? Awesome! There are many ways you can contribute.

Improving the docs

Documentation is extremely important and takes a fair deal of time and effort to write and keep updated. Everything is written in Markdown to facilitate the process of contributing.

Docs Setup Guide

Docs Setup Guide

1. Clone the repository

   git clone https://github.com/MailPigeonApp/docs.git
   

2. Install mintlify

   yarn global add mintlify
   

3. Start the development server

   mintlify dev
   

4. Open http://localhost:3000 with your browser to see the result.

Opening Issues

Open an issue if you find a bug or if you have a feature request. Please make sure to check if the issue already exists before opening a new one.

• Reporting bugs: describe the bug as clearly as you can, including steps to reproduce, what happened and what you were expecting to happen. Also include browser version, OS and other related software’s (npm, Node.js, etc) versions when applicable.

• Suggesting features: describe the feature you would like to see implemented and why you think it would be useful.