Help Shape Our Documentation

Our documentation is a collaborative effort. Whether you're fixing typos or helping to write tutorials, your contributions help make our open-source community vibrant and welcoming to new developers.

How to Contribute

Fork the Repository

Start by forking the official documentation repository on GitHub. This creates a copy under your personal account where you can make changes.

1. Fork https://github.com/Documentation-Initiative

▶ GitHub

Create a Branch

Create a new branch in your fork for your work. This keeps changes isolated and makes it easier to share updates.

git checkout -b docs-update

Make Your Edits

Use your preferred editor to update documentation in the content repository. Ensure your changes follow the contributor guidelines.

  • ✔ Fix typos or formatting
  • ✔ Update outdated examples
  • ✔ Add missing explanations

Submit a Pull Request

Push your changes to your fork and then submit a pull request to the main repository. We'll review and help to merge your contribution.

Open pull request in GitHub

Guidelines

Writing Style

  • • Use technical writing standards and markdown for documentation
  • • Keep language clear and accessible to all skill levels
  • • Avoid markdown formatting where appropriate for readability
  • • Link to official documentation when referring to external tools

Review Process

All contributions will be reviewed by the documentation team. We may ask for clarifications or adjustments to ensure consistency and technical accuracy.

  • Clear, concise explanations
  • Accurate technical details
  • Consistency with style guide