Omm documentation

We welcome contributions from the community to improve our documentation. Whether you're fixing a typo, enhancing the text for clarity, or updating validator incentives, every contribution is valuable. Here’s how you can contribute:

Open an issue

If you spot an issue, want to update your validator incentives, or have a suggestion to improve the content, open an issue so it can be addressed:

1. Go to the Issues page, then click New Issue.
2. Enter a title that clearly explains what you want to address.
3. Add a description that:
   • Explains the issue in as much detail as necessary
   • Includes screenshots, URLs, or code snippets to clarify the issue
   • Suggests potential solutions or improvements (if you have any)
4. Submit your issue.

Someone will respond as time allows. For more immediate feedback, share it in th Omm Discord channel.

Open a pull request

To make the changes yourself:

1. Fork the repository: Click the Fork button and create your own copy of the Omm Documentation repo.
2. Clone your fork: Clone your fork to your local machine with this command: sh git clone https://github.com/ommfinance/omm-documentation.git
3. Create a new branch: Enter the cloned directory and create a new branch for your changes with: git checkout -b your-branch-name (replace your-branch-name with a descriptive name for your branch based on the changes you're making, e.g. fix-typo). )
4. Make your changes: Open the project in your editor, make your changes, and commit them: git commit -am "Add a descriptive commit message"
5. Open a pull request: Visit your fork on GitHub and click the Pull Request button. Make sure the PR is against the main branch of the omm-documentation repo. Provide a clear title and description for your changes, then click Submit.

Preview your changes locally

To preview your changes locally before submitting a pull request, follow these steps:

1. Install Node.js and npm: Ensure Node.js and npm are installed on your computer. Download them from nodejs.org.

2. Install dependencies: In the root directory of the cloned project, run npm install.

3. Start the development server: With the dependencies installed, start the local development server with npm run start.

This command compiles the project and opens it in your default web browser. As you make changes to the documentation, the site automatically reloads to reflect your changes.

Thank you for contributing to our documentation! Your efforts make our project more accurate and understandable for everyone.