Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Documentation for developers presents an opportunity for edX and the Open Source community. Currently, documentation is scattered across a number of repos, wiki pages, GitHub, and other sources.

See also Developer Documentation in the Open edX Development / Engineering wiki.

Anchor
OpenEdXDevelopersGuide
OpenEdXDevelopersGuide

...

The process for creating or updating documentation in this guide is the process outlined on the Creating and Updating Documentation - RTD page.

IDA Documentation

EdX has a number of independently deployable applications (IDAs), each with its own documentation that is located in the same repo as the IDA. The ECOM team and docs team have discussed the best location for IDA documentation—should documentation for an IDA be with the code, or should it be in the edx-documentation repo?—but have not come to a definitive conclusion. For information about these discussions, see the following pages.

...