# Contributing documentation

Source: https://design.ritchiebros.com/contributing/documentation/

Clear, current documentation keeps Orbit trustworthy. Copy edits, new examples, and new guidance are all welcome.

## Write with a cross-discipline lens

Documentation should meet both UX and development needs, so write with a cross-discipline lens. If you’re not sure whether a piece of content belongs on the portal or somewhere else, the Orbit team can help you figure it out.

## Making copy edits

Edits for spelling, grammar, punctuation, or typos should happen quickly and often. To fix a copy issue on the portal, open a pull request. If you find copy issues in other Orbit resources, follow the contribution guidelines for that resource.

## Updating documentation

- Draft your proposed changes somewhere easy to collaborate; writing in Markdown keeps the handoff simple.
- Get feedback from subject-matter experts or someone with high context on the change.
- Ask the Orbit team to review your changes for style-guide alignment.
- Open a pull request.

## Adding new documentation

New documentation can range from component docs to content guidelines to pattern guidance.

- Reach out to the Orbit team early — they can help find a home for it, offer templates, and give feedback.
- Draft the content somewhere collaborative, ideally in Markdown.
- Get feedback from subject-matter experts or someone with high context.
- Open a pull request.

## Removing documentation

Inaccurate or outdated information should be removed as soon as possible — it keeps Orbit trustworthy as a source of truth. Before removing content, confirm its relevance with a subject-matter expert, then open a pull request.