Skip to content

Contributing to Simplyblock Documentation

Overview

Simplyblock's documentation is publicly available, and we welcome contributions from the community to improve clarity, fix errors, and enhance the overall quality of our documentation. While simplyblock itself is not open source, our documentation is publicly hosted GitHub. We encourage users to provide feedback, report typos, suggest improvements, and submit fixes for documentation inconsistencies.

How to Contribute

The simplyblock documentation is built using mkdocs, specifically using the mkdocs-material variant.

Changes to the documentation can be made by changing or adding the necessary Markdown files.

1. Provide Feedback or Report Issues

If you notice any inaccuracies, typos, missing information, or outdated content, you can submit an issue on our GitHub repository:

  1. Navigate to the Simplyblock Documentation GitHub Repository.
  2. Click on the Issues tab.
  3. Click New Issue and provide a clear description of the problem or suggestion.
  4. Submit the issue, and our team will review it.

2. Make Edits and Submit a Pull Request (PR)

If you'd like to make direct changes to the documentation, follow these steps:

  1. Fork the Repository

  2. Visit Simplyblock Documentation GitHub and click Fork to create your own copy of the repository.

  3. Clone the Repository

  4. Clone your fork to your local machine: 

    git clone https://github.com/YOUR_USERNAME/documentation.git
cd documentation

  5. Create a New Branch

  6. Always create a new branch for your changes: 

    git checkout -b update-docs

  7. Make Changes

  8. Edit the relevant Markdown (.md) files using a text editor or IDE. The documentation files can be found in the /docs directory.

  9. Ensure that formatting follows existing conventions.

  10. Commit and Push Your Changes

  11. Commit your changes with a clear message: 

    git commit -m "Fix typo in installation guide"

  12. Push the changes to your fork: 

    git push origin update-docs

  13. Create a Pull Request (PR)

  14. Navigate to the original simplyblock documentation repository.

  15. Click New Pull Request and select your branch.
  16. Provide a concise description of the changes and submit the PR.
  17. Our team will review and merge accepted contributions.

Contribution Guidelines

  • Ensure all content remains clear, concise, and professional.
  • Follow Markdown syntax conventions used throughout the documentation.
  • Keep changes focused on documentation improvements (not product functionality).
  • Be respectful and constructive in all discussions and contributions.

Getting in Touch

If you have questions about contributing, feel free to open an issue or contact us via the simplyblock support channels.