Skip to content

docs(games-xblock): add Games XBlock documentation#12

Merged
abhalsod-sonata merged 1 commit into
masterfrom
feat/TNL2-585
Apr 22, 2026
Merged

docs(games-xblock): add Games XBlock documentation#12
abhalsod-sonata merged 1 commit into
masterfrom
feat/TNL2-585

Conversation

@pganesh-apphelix
Copy link
Copy Markdown

@pganesh-apphelix pganesh-apphelix commented Apr 20, 2026

Description

Add documentation for the new Games Block component, which allows course authors to create interactive Flashcards and Matching game activities in Studio.

Changes include:

  • New RST page: en_us/shared/exercises_tools/games_block.rst
  • New include wrapper: en_us/course_authors/source/exercises_tools/games_block.rst
  • Added games_block entry to en_us/course_authors/source/exercises_tools/index.rst (alphabetically between full_screen_image and gene_explorer)
  • 15 screenshots extracted from source document and saved to en_us/shared/images/ covering the Add Component panel, Flashcards editor, Flashcards Studio preview, Matching game editor, Matching game board, match feedback states, and congratulations screen

Covers the following topics:

  • Adding a Games Block to a course unit
  • Flashcards Editor: entering terms/definitions, adding images, reordering cards, three-dot menu, adding alt text, Settings panel (Type and Shuffle)
  • Flashcards Studio View: previewing cards, navigating with arrows
  • Matching Game Editor: switching to Matching type, timer option, Settings panel
  • Studio View for Matching Game: game board layout, correct/incorrect match feedback, congratulations screen

Reference: https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/exercises_tools/index.html

Jira

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives 👍.

  • Subject matter expert:
  • Product review:
  • Partner support:
  • PM review:

Testing

  • Ran ./run_tests.sh without warnings or errors

Copilot AI review requested due to automatic review settings April 20, 2026 06:43
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds end-user documentation for the new “Games” XBlock (Flashcards + Matching) to the partner course staff docs, including a shared RST page, a course-authors include wrapper, a new toctree entry, and supporting screenshots.

Changes:

  • Added new shared documentation page for the Games block (Flashcards + Matching workflows).
  • Added course-authors include wrapper and linked the new page from the exercises/tools index.
  • Added new screenshots under en_us/shared/images/ referenced by the new doc page.

Reviewed changes

Copilot reviewed 3 out of 18 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
en_us/shared/exercises_tools/games_block.rst New shared RST documentation for adding/configuring/previewing Games block activities.
en_us/course_authors/source/exercises_tools/games_block.rst Wrapper include so the shared page is available in the course author guide build.
en_us/course_authors/source/exercises_tools/index.rst Adds games_block to the exercises/tools toctree (needs reordering per comment).
en_us/shared/images/matching_studio_start.png New screenshot referenced by the Matching Studio View section.
en_us/shared/images/matching_settings_panel.png New screenshot referenced by the Matching settings section.
en_us/shared/images/flashcards_studio_start.png New screenshot referenced by the Flashcards Studio View section.
en_us/shared/images/flashcards_settings_panel.png New screenshot referenced by the Flashcards settings section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread en_us/course_authors/source/exercises_tools/index.rst Outdated
@abhalsod-sonata abhalsod-sonata merged commit 0d558ea into master Apr 22, 2026
1 check passed
@abhalsod-sonata abhalsod-sonata deleted the feat/TNL2-585 branch April 22, 2026 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants