Skip to content

Contributing to Simplyblock Documentation

Overview

Simplyblock's documentation is publicly available, and contributions from the community to improve clarity, fix errors, and enhance its overall quality are welcome. While simplyblock itself is not open source, the documentation is publicly hosted GitHub ⧉. Feedback, reported typos, suggested improvements, and fixes for documentation inconsistencies are all appreciated.

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

Inaccuracies, typos, missing information, and outdated content can be reported as an issue on the 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. The simplyblock team reviews it.

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

Direct changes to the documentation follow these steps:

  1. Fork the Repository

  2. Visit Simplyblock Documentation GitHub ⧉ and click Fork to create a personal copy of the repository.

  3. Clone the Repository

  4. Clone the fork to a 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 the 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 the Changes

  11. Commit the changes with a clear message: 

    git commit -m "Fix typo in installation guide"

  12. Push the changes to the 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 the branch.
  16. Provide a concise description of the changes and submit the PR.
  17. The simplyblock team reviews and merges 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

Questions about contributing can be raised as an issue or through the simplyblock support channels.