2.1 KiB
Contributing to Appsmith Documentation
Thank you for your interest in Appsmith and taking the time out to contribute to our documentation. 🙌 Feel free to propose changes to this document in a pull request.
Appsmith uses Gitbook for documentation. The docs are backed by the appsmith-docs repository
Suggesting Improvements
If you feel parts of our documentation can be improved or have incorrect information, you can open a new issue using our Documentation Template
Contributing
Our good first issues list is the best place to begin contributing
Updating the docs
Before raising a pull request, ensure you have raised a corresponding issue and discussed it with a maintainer. This gives your pull request the highest chance of getting merged quickly.
- Fork the appsmith-docs repo and branch out from the default branch.
- If a new release is being created, contact a maintainer to update the default branch to mirror the new release version.
- Read our guidelines for the section you wish to update
- Add / Update the relevant files and commit them with a clear commit message
- Create a pull request in your fork to the default branch in the appsmithorg/appsmith-docs base repository
- Link the issue of the base repository in your Pull request description. Guide
Guidelines
To maintain consistency, we have a set structure for the different types of documentation pages on appsmith. Refer to the following when updating the docs