Contributing

Contributing#

Getting Started#

We welcome contributions to keep this documentation fresh and accurate. Whether you’re fixing typos, clarifying explanations, or adding new content, your help makes this a better resource for everyone.

How to Contribute#

  1. Fork the repository (https://github.com/spaceml-org/surya_workshop) and create a new branch for your changes

  2. Edit the markdown files in the docs/source/ directory

  3. Submit a pull request with a clear description of your changes

  4. Review process: Maintainers will review within a few days

Guidelines#

  • Keep explanations clear and concise

  • Use consistent formatting and tone

  • Test any code examples you include

  • Update the table of contents if adding new sections

  • Reference issues or related documentation when relevant

Missing Manual Philosophy#

This documentation evolves with community feedback. If you notice:

  • Outdated information

  • Gaps or unclear sections

  • Better ways to explain concepts

Please open an issue or submit a PR. All contributions help us maintain accurate, helpful documentation.

Questions?#

Open an issue on GitHub or reach out to the maintainers. We’re here to help!