Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.charmos.io/llms.txt

Use this file to discover all available pages before exploring further.

Thanks for helping improve Charm. Contributions can include code, templates, docs, tests, bug reports, and product feedback.

​
How to Contribute

  1. Fork the repository.
  2. Create a branch for your change.
  3. Make the smallest focused change that solves the problem.
  4. Run relevant checks.
  5. Open a pull request.

​
Pull Request Expectations

Every PR should include:
  • what changed,
  • why it is needed,
  • how reviewers can validate it,
  • screenshots or logs for UI/runtime changes,
  • docs updates when behavior changes,
  • migration or deploy notes when relevant.

​
Good First Contributions

  • Fix docs gaps.
  • Improve examples.
  • Add tests around existing behavior.
  • Clarify error messages.
  • Improve templates.

​
Community Standards

Before contributing, please review the Code of Conduct. It explains expected behavior, unacceptable behavior, and how to report a concern privately.

​
Local Setup

See Development Environment.