Skip to main content

Contributing to Our Documentation

Thank you for your interest in contributing! This guide outlines our conventions and workflow to ensure that all documentation is consistent, high-quality, and easy to maintain.

Documentation Structure​

Each project has a dedicated docs folder that contains all the documentation files. The typical structure is as follows:

  • docs/: The root folder for documentation.
  • docs/img/: A folder for images and other media assets.
  • docs/*.md: Markdown files containing the documentation content.

Workflow for Documentation​

To streamline the process, please follow these steps when contributing documentation:

  1. Fork and Clone: Fork the repository and clone your fork locally.
  2. Create a Branch: Create a new branch (e.g., docs-update-feature) for your changes.
  3. Make Your Changes: Add or update the documentation files in the docs folder according to the guidelines.
  4. Commit and Push: Commit your changes with a clear commit message and push the branch to your fork.
  5. Submit a Pull Request: Open a pull request for review. Our team will review your changes and provide feedback if needed.
tip

For component documentation, please contribute directly in the respective repositories:

Image Integration​

When adding images to the documentation, please use the following snippet to ensure proper display:

<p align="center">
<div style={{ maxWidth: '300px' }}>
    ![App settings view](./img/settings.jpeg)
</div>
</p>

This snippet centers the image and restricts its maximum width to maintain a consistent look across the documentation. Adjust the parameters if needed, but please keep the overall formatting consistent.

Additional Guidelines​

  • Formatting & Style: Use Markdown for text formatting and inline HTML only when necessary. Keep your writing clear and consistent with the project’s style.
  • Consistency: Maintain a consistent tone and format across all documentation. Follow any specific style guidelines provided by the project.
  • Review and Testing: After making changes, review your documentation locally to ensure everything renders correctly before submitting your pull request.

Questions and Feedback​

If you have any questions or need further assistance, please open an issue or contact the maintainers. We appreciate your contributions and look forward to your improvements!

Thank you for helping us improve our project documentation!