The edx-documentation repo contains source files for most of the documentation for edX partners and the Open edX community. This repo is managed by the edX Documentation team.
API documentation that includes docstrings from code files is stored in the repository of that module.
Documentation for developers, researchers, course staff, and students is located in the language-specific subdirectories.
EdX documentation is published through Read the Docs. Links to all published documentation are available through docs.edx.org.
We welcome input from the community on any documentation issues. You can submit issues to the Documentation project in the Open edX JIRA board.
You can also email [email protected].
You, the user community, can help update and revise edX documentation.
EdX documentation is created using RST files and Sphinx.
To suggest a revision, fork the project, make changes in your fork, and submit a pull request back to the original project: this is known as the GitHub Flow.
All pull requests need approval from edX. For more information, contact edX at [email protected].