openedx / openedx/docs.openedx.org
[Developer] Integrate Repo Docs into the Reference Area
Open
@feanil is already working on this.
Since Jul 18, 2022.
developers
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
Developer content may come from docs that live in the relevant repo. Update the reference space so that you can easily navigate to documentation for repos that are a part of the Open edX platform.
- Do this work ourselves on 2-3 pilot repos.
- Use that to write how-tos that can be used by maintainers to do this work on their own repos.
- Ask the maintainers to do this work in repos they maintain, give them a quarter or two to complete it.
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.