Skip to content

How to Contribute to the Documentation

Good documentation is essential. If you find any part of the documentation unclear, incorrect, or missing information, please consider contributing.

The documentation is written in Markdown and located in the docs/ directory of the project repository.

Making Changes

  1. Follow the development workflow described in How to Contribute to this Plugin to set up your local repository.
  2. Navigate to the docs/ directory.
  3. Edit the relevant Markdown files. You can add new pages, update existing content, or fix typos.
  4. Preview your changes locally if possible.
  5. Commit and push your changes, then open a Pull Request with a clear description of the improvements you've made.

If you are adding a new page, remember to link it from the appropriate section in the main index.md file.