Adaptive learning: Update documentation to match new mastery calculation

[JohannesStoehr]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

#8791 improved and changed the mastery calculation. This should be reflected in the documentation as well.

Description

Changed the description and screenshots of progress/mastery/mastery threshold in these two pages of the documentation:

• Student page about adaptive learning
• Instructor page about adaptive learning

Steps for Testing

1. Go to the new documentation and read the pages

Review Progress

Review

• Review 1
• Review 2
• Review 3

Summary by CodeRabbit

• Documentation
  • Updated instructor and student documentation to enhance clarity on competency metrics, including new progress and mastery criteria.
  • Introduced bipartite rings visualization to represent student advancement, with tooltips explaining discrepancies between progress and mastery metrics.

[coderabbitai]

Walkthrough

The update to the adaptive learning documentation introduces enhanced tracking of student competencies by differentiating between progress and mastery metrics. These newly refined metrics incorporate various heuristics, such as score comparisons, exercise difficulty levels, and speed of completion for programming tasks, to provide a more accurate measurement of student skill levels. The changes aim to offer clearer, more meaningful insights into student progress and mastery, ultimately improving their learning outcomes.

Changes

File Path	Change Summary
docs/user/adaptive-learning/adaptive-learning-instructor.rst	Introduced metrics for student competencies, updated mastery calculation criteria, clarified mastery threshold terminology, explained progress and mastery mechanisms.
docs/user/adaptive-learning/adaptive-learning-student.rst	Updated competency measurement system, emphasized separated tracking of progress and mastery, introduced bipartite rings to visualize student advancement, added tooltips.

Sequence Diagram(s)

sequenceDiagram
    participant Instructor
    participant System
    participant Student

    Instructor ->> System: Define competency metrics and thresholds
    Student ->> System: Complete lecture unit/exercise
    System ->> Student: Calculate and update progress
    System ->> Student: Calculate and update mastery
    Student -> System: Check progress and mastery
    System -> Student: Display bipartite rings and tooltips
    Student -> Instructor: Seek clarification if needed

Loading

Possibly related issues

• Issue Key: Adaptive learning: Improve progress, mastery and confidence #8756: The changes in this PR align with the proposed improvements in measuring progress, mastery, and confidence suggested in this issue, addressing the need for more accurate and meaningful competency metrics for students.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between dd6b1d1 and 4707f4c.

Files selected for processing (1)

• docs/user/adaptive-learning/adaptive-learning-instructor.rst (2 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

[egekurt123]

One small optional suggestion, LGTM

[Jan-Thurner]

The new docs lgtm. I left an optional comment. Please fix the List layout mentioned by @bensofficial, though.

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Actionable comments posted: 2

[pzdr7]

👍

[MaximilianAnzinger]

Maintainer approved