Orb Documentation

Here you'll find guides, tutorials, and reference materials to help you get the most out of the Orb app & platform.

Contributing to Documentation

We welcome contributions from the community to improve the Orb documentation. The documentation is hosted on GitHub at github.com/orbforge/orb-docs.

The Orb documentation welcomes community contributions. For full instructions, please visit the GitHub repository. Here's a quick overview:

Edit directly on GitHub.com (click the pencil icon on any file) or clone the repo locally
Documentation is written in Markdown with frontmatter metadata
Place images in the /images folder and use relative paths
When linking to other docs, use absolute paths without domain (e.g. /docs/install-orb/ios)
Add your new docs to navigation.md and run the link validator
Submit a pull request with a clear description of your changes
Maintainers will review, provide feedback if needed, and merge approved contributions

Please report issues to the appropriate repository:

Issues with the Orb app & platform should be reported in the orb-issues repository
Issues with the documentation should be reported in the orb-docs repository