We're so happy you're here! We welcome contributions of all kinds, particularly issues and pull requests. Please read on for instructions on how to participate.

This repository contains source files for the Open edX Documentation site. This repository is managed by the Open edX documentation working group, and maintained by the docs-openedx-org-maintainers GitHub group.

The Open edX Documentation site contains documentation for:

• Educators
• Learners
• Site Operators
• Developers

Documentation for other components of the Open edX ecosystem is found in each component's repository. When known, links to other documentation are provided in the Open edX Documentation.

We welcome input from the community on Open edX documentation. You can report a problem or suggest an improvement to the documentation issues by following the Report a Problem instructions.

You, the user community, can help update and revise Open edX documentation!

Open edX documentation is published from RST source files using Sphinx.

Here are some resources for getting started:

• First docs PR using the GitHub UI
• Update existing docs through GitHub
• Add new documentation through GitHub
• More resources available at the Documentors Homepage

While viewing documentation, you can easily propose a change by selecting suggest edit from the menu under the GitHub icon. The page you are viewing then opens in GitHub, in edit mode. When you save your edits, create a new branch, commit your changes, and create a new Pull Request, to have your changes reviewed by the Open edX team.

For developers comfortable pulling down the repository locally and making changes (see GitHub Flow), you can build the documentation directly on your machine.

See the How-to Develop Documentation Locally guide.