Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (38 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

48 lines (38 loc) · 1.7 KB

Contributing to PowerSync Docs

Thanks for contributing to our documentation!

License & Contributor License Agreement (CLA)

The PowerSync docs, like the Service, are licensed under the Functional Source License (FSL). To contribute, you must accept our Contributor License Agreement (CLA). This is an automated process that occurs when you submit your first pull request (PR).

How to Contribute

  1. Fork and clone your repository:
    • On GitHub, click "Fork" at the top right of this repository to create your own copy.
    • Then clone your fork: 
      git clone https://github.com/YOUR-USERNAME/powersync-docs.git
cd powersync-docs
  2. Install Mintlify CLI: 
    npx mintlify install
  3. Start the local docs server: 
    npx mintlify dev
    (See the README for more details and troubleshooting.)
  4. Make your changes:
  5. Test your changes locally
  6. Submit a pull request:
    • Push your changes to your fork.
    • Open a PR to powersync-ja/powersync-docs:main.
    • Sign the CLA when prompted.
    • Ensure all checks pass (including broken link checks).
    • Request a review.

Publishing

Once your PR is approved and merged to main, your changes will be automatically published to https://docs.powersync.com.

Getting Help

If you have questions or need help:

  • Join our Discord server to ask questions and connect with the community.
  • Open an issue on GitHub if you encounter a problem or have a suggestion.

Happy documenting!