old and incomplete docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 470
- Forks
- 231
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 6
Description
XBlocks are the heart of Open edX. Yet, somehow the documentation around it is not complete.
There are a lot of places that are referenced for future fixes or mentioned TODO. like:
- There's no information about Runtime services.
https://docs.openedx.org/projects/xblock/en/latest/runtime.html#xblock.runtime.Runtime.service
I found this in Jira but it's quite old: https://openedx.atlassian.net/wiki/spaces/AC/pages/161400730/Open+edX+Runtime+XBlock+API - https://docs.openedx.org/projects/xblock/en/latest/xblock-tutorial/introduction.html#other-open-edx-resources
You, the user community, can help update and revise this documentation project on GitHub.
- Nowhere inside the docs is mentioned about cookiecutter-xblock, but I think that's the standard approach to start with xblocks.
https://edx.readthedocs.io/projects/xblock/en/latest/xblock-tutorial/getting_started/ - No reference to
needsandwantsdecorators. (I know we can find the class method description https://edx.readthedocs.io/projects/xblock/en/latest/xblock.html#xblock.core.XBlock.needs but it's not clear for someone who's trying to develop an XBlock)
PS. We can add a tutor approach for installing xblocks as well.
@openedx/axim-engineering
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 with the XBlock Runtime API page and the xblock-tutorial pages linked in the issue, then compare them with the older Runtime XBlock API reference and cookiecutter-xblock repository. Define the documentation scope before editing: runtime services, cookiecutter-based setup, needs and wants decorators, and any Tutor installation guidance. Done means the selected topics are documented in the relevant tutorial or reference pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100