CONTRIBUTING.md

Contributing

We welcome contributions from the community! Follow the steps below to get started.

You can also choose to simply submit an issue and the team would be more than happy to look into this for you!

Prerequisites

Make sure you have the following installed:

• Node.js
• Yarn

Install Dependencies

First, clone the repository and navigate into the project directory:

git clone https://github.com/your-username/paradex-docs.git
cd paradex-docs

Then, install the project dependencies with:

yarn install

Preview Docs

To start the Fern server and preview the documentation locally, run:

yarn dev

If everything goes right, you should see a message like:

Running server on http://localhost:3000

Visit the URL in your browser to see the documentation.

Making Changes

1. Create a new branch for your changes:

   git checkout -b my-feature-branch

2. Make your changes in the appropriate files.

3. Commit your changes with a meaningful commit message:

   git commit -m "Add feature X"

4. Push your changes to Github:

   git push origin my-feature-branch

5. Open a pull request on GitHub.

Additional Resources

• Paradex Documentation
• Paradex Code Samples
• Fern Documentation