edx-platform Documentation#
Developer documentation for edx-platform can be found in the following locations.
The edx-platform docs directory contains some local developer documentation.
The Developer Documentation Index in Confluence provides additional links to developer documentation for this and other projects. The rest of the Open edX Development space in Confluence provides additional documentation.
User documentation and a more general Developer’s Guide can be read on Open edX ReadTheDocs. The source for these guides can be found in the edx-documentation repository.
Change History#
Jun 30, 2023
Added API, Feature Toggle and Settings docs.
Re-organized how the docs are laid out.
December, 2020: Added documentation about new protocols for writing celery tasks.
April, 2019: API and repository-specific documentation builds resumed.
May, 2017: The local docs directory was cleared out to start fresh.
January 13, 2015: The “edX Developer’s Guide” was moved to edx-documentation.
November 3, 2014: The documentation for several sub-projects were moved into edx-documentation.