Improve edx-platform docs and discoverability

openedx / edx-platform

The Open edX LMS & Studio, powering education sites around the world!

https://openedx.org

GNU Affero General Public License v3.0

7.47k stars 3.89k forks source link

Open robrap opened 5 months ago

robrap commented 5 months ago

This is a follow-up to https://github.com/openedx/edx-platform/issues/33327, which made app-level docs part of the edx-platform readthedocs output.

Improvement ideas:

Add app-level READMEs
Add top-level index page to make discovery of app-level docs easier.
Eventually update OEP-19 with best practices for exposing these for a repo based on experience with edx-platform.

farhan commented 4 months ago