Development: Add documentation for the review system within programming exercises

[IcanCUthere]

Summary

This PR adds instructor/editor-facing documentation for the new review system to make it more clear how to use it.

Checklist

General

• This is a small issue that I tested locally and was confirmed by another developer on a test server.
• 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

The newly introduces review system needs user-facing documentation as it adds a lot more things to the online-editor.

Description

This PR adds documentation for the new review system, it adds a description, screenshots and a link to a TUMlive video.

Steps for Testing

Prerequisites:

• Local Artemis clone with chore/programming-exercises/add-review-comment-documentation checked-out

1. Inside the Artemis Repo go to /documentation
2. Run npm start
3. Go to http://localhost:3000
4. Click Instructor documentation > Exercises > Programming Exercises
5. See the new Review Comments section under Collaborative Editing on the right sidebar (make sure it navigates correctly)
6. Make sure you can watch the linked TUMlive video and see the screenshots

Testserver States

You can manage test servers using Helios. Check environment statuses in the environment list. To deploy to a test server, go to the CI/CD page, find your PR or branch, and trigger the deployment.

Review Progress

Performance Review

Code Review

• Code Review 1
• Code Review 2

Manual Tests

• Test 1
• Test 2

Test Coverage

No code changes detected - test coverage not required for this PR.

Last updated: 2026-04-22 09:07:50 UTC

Screenshots

Summary by CodeRabbit

• Documentation
  • Added comprehensive guide on review comments functionality, covering how instructors create and manage comment threads tied to specific code lines, monitor real-time updates across editors, track resolution status, and utilize AI-generated consistency checks with severity labels and inline fix suggestions.

[coderabbitai]

Walkthrough

Documentation added explaining how instructors and editors create review comment threads attached to specific lines in the online code editor. The section covers supported artifacts, real-time updates, resolved/unresolved states, AI-generated consistency check labels, and notes that threads reference saved content and may become outdated if lines change.

Changes

Cohort / File(s)	Summary
Documentation Enhancement documentation/docs/instructor/exercises/programming-exercise.mdx	Added new "Review Comments" section with image asset imports and detailed explanation of instructor review comment functionality, including thread creation, artifacts, real-time behavior, resolution states, AI consistency checks, and content references.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: adding documentation for the review system within programming exercises, which matches the changeset content.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/programming-exercises/add-review-comment-documentation

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[sawys777]

Documentation LGTM

[HawKhiem]

Documentation lgtm 👍

[Elfari1028]

looks good! approved

[bensofficial]

Tested locally