openedx / openedx/openedx-core

Document API concept mapping between platform and core

Open
#435 3 comments 0 reactions 1 assignee View on GitHub

@ormsbee is already working on this.

Since Nov 18, 2025.

Dominant language
Python
Stars
10
Forks
32
Avg merge
2d 17h
Merged PRs (30d)
12

Description

We have found many cases where there is a openedx-core concept and a parallel opendx-platform concept.

AC: Write down these mappings, and explain when one should be used or the other. Where helpful for developers, add this information to the docs. Where we are missing parallel concepts, makes notes of this.

Examples:

  • Do we score XBlocks, or Components?
  • XBlocks types have sub-types (Problem:MC vs. Problem:DropDown). Should Components, too?

@ormsbee will fill in

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.