openedx / openedx/XBlock

old and incomplete docs

Open
#774 10 comments 0 reactions 0 assignees View on GitHub

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:

PS. We can add a tutor approach for installing xblocks as well.

@openedx/axim-engineering

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.