Updated Outdated Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 470
- Forks
- 231
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
https://edx.readthedocs.io/projects/xblock-tutorial/en/latest/edx_platform/edx.html is outdated and should be updated.
It should probably also be replaced with documentation provided by this repository rather than living in the edx-documentation repo.
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.
Research direction
Start by reviewing the linked edx.html page and the XBlock repository's existing documentation structure. Determine what is outdated and whether the page can be replaced by documentation in this repository; the work is done when the documentation is updated or relocated and the old source is no longer needed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100