This page is not the current release of O3DE documentation. Click here to switch to the latest release, or select a version from the dropdown.

Version:

  Edit on GitHub

IN THIS ARTICLE

Contributing to O3DE Documentation

Welcome to Open 3D Engine (O3DE) documentation!

O3DE documentation is driven by contributors like you. Whether you want to report an issue, document a feature, provide a tutorial, or join the O3DE Documentation and Community Special Interest Group (SIG-Docs-Community), this guide will provide you the information you need. Your participation is critical. Large or small, your contributions chart the course of O3DE documentation.

Becoming a contributor

Although there are many avenues for discussion with O3DE users and contributors, all official communication regarding O3DE docs is done through pull requests (PRs) and issues in the o3de/o3de.org GitHub repository .

O3DE welcomes feedback, suggestions, and improvements from all, no matter their level of experience. To learn how you can be an inclusive contributor, see the O3DE Code of Conduct .

Wondering where to start? The conveniently titled Get Started topic provides an overview of the O3DE docs contribution process, as well as guidance on the best ways to start as a contributor.

TopicDescription
Get StartedA high-level overview of the O3DE docs contribution process.
Work with IssuesHow to create and work with issues in the O3DE docs project.
Set up a Local O3DE Docs RepoA step-by-step guide to setting up and maintaining your O3DE docs repo.
Docs Contribution RunbookGet the Git commands for the basic workflow.
O3DE Docs StructureNeed guidance on navigating the repository? This map will help.
Submit a PRNavigate the pitfalls of making submissions to O3DE docs.
Style GuideThe fine details on how to consistently format and style docs for O3DE.
TerminologyO3DE has many specialized terms, and a handful of terms that you shouldn’t use.
Work with HugoLearn to work with Hugo, the static site generator for O3DE docs.
O3DE Documentation and Community Special Interest Group The hub of the O3DE Documentation and Community Special Interest Group (D&C SIG), the governing body for O3DE docs.
Blog Post SubmissionHave a blog post that you’d like to see featured on o3de.org? Learn how to go through our submission and approval process.
Templates for O3DE DocumentationDownload templates and follow supplemental guidelines for writing O3DE documentation.