openedx / openedx/openedx-platform
Setup a root edx-platform documentation site
Open
@feanil is already working on this.
Since Jun 22, 2023.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Currently there are multiple ReadTheDocs projects that are built out of edx-platform. Most of them are single purpose and there is no unifying edx-platform docs site. This makes it very difficult to display the documentation that lives alongside the code and makes it harder to discover and understand what is in the edx-platform code base.
Setup a root edx-platform documentation site that is integrated with docs.openedx.org and can be used to start indexing the current documentation that lives in the edx-platform repo.
AC:
- New docs site for edx-platform
- Is a sub-project of docs.openedx.org
- Has a clear place to start referencing docs in specific djangoapps.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.