openedx / openedx/openedx-core

[Release Docs] Docs Notes for Competency ID

Open
#650 0 comments 0 reactions 1 assignee View on GitHub

@thelmick-unicon is already working on this.

Since Jul 8, 2026.

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

Description

This issue adds user-facing documentation for the Competency ID.

Documentation should explain what a Competency ID is, when a course author or admin encounters or needs it, how it is assigned or displayed, and where it appears in the platform (authoring UI, APIs, or both). Documentation should follow the same process used for the previous taxonomy editing work, with docs added to the Open edX documentation repository.

Release notes are not expected to be created as part of this ticket. Axim is experimenting with generating release notes separately, and the team may share those for review if needed.

Documentation Location:
Documentation should be added to the Open edX documentation repository:
https://github.com/openedx/docs.openedx.org

Outstanding/Needs Confirmation:

  • Confirm the exact documentation page or section where Competency ID content should be added in the repository.
  • Confirm what "Competency ID" refers to here: the internal id, the stable uuid, or a client-facing key (per this repo's identifier convention, these are three distinct fields) — the docs should describe the one users actually see and use.

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.