Development: Update the editor-related screenshots in the documentation

[pzdr7]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• I chose a title conforming to the naming conventions for pull requests

Motivation and Context

The documentation contains several screenshots that do not reflect the current state of the code editors in Artemis.

Description

I updated the screenshots that featured the editor in a meaningful way.

Steps for Reviewing

1. Deploy on a test server
2. In the footer, click "About", then on 6. Exam mode, go to both the page for "Students" and "Instructors" and check that the screenshots are up to date. (You may have to clear your cache if they are not.)
3. Review the other screenshots that were updated in the documentation: The pages/sections affected are:

• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/programming.html#verify-the-exercise-configuration
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/programming.html#online-editor
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/programming.html#manual-assessment
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/quiz.html#prepare-a-quiz-exercise (each question type)
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/modeling.html#create-new-modeling-exercise (near example solution / explanation / release date)
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exercises/textual.html (near example solution)
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/lectures.html#managing-lectures
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/lectures.html#attachment-unit (Attachment unit and below)
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/exams/instructors_guide.html#assess-student-exams (fig. Manually Assessing a Programming Submission)
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/tutorialgroups.html#creating-tutorial-groups
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/plagiarism-check.html#instructors ("5. Notify the student...")
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/adaptive-learning/adaptive-learning-instructor.html#create-edit-competencies
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/adaptive-learning/adaptive-learning-instructor.html#generate-competencies
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/markdown-support.html
• https://artemis-platform--9552.org.readthedocs.build/en/9552/user/icl/local-version-control.html#access-repositories-as-a-student

Testserver States

Note

These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.

Review Progress

Reviews (steps above)

• Review 1
• Review 2

Test Coverage

Unchanged

Screenshots

Please refer to the links above to see the changes in the documentation

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and structure of the adaptive learning instructor guide, particularly on linking competencies.
  • Improved readability and layout of the lecture management document with increased image widths for better visibility.
  • Maintained instructional integrity while refining content for clarity.

[coderabbitai]

Walkthrough

The pull request includes modifications to two documentation files: adaptive-learning-instructor.rst and lectures.rst. The changes in adaptive-learning-instructor.rst focus on enhancing clarity and structure regarding the management of competencies in adaptive learning, while lectures.rst features updates primarily related to the formatting and visibility of images associated with lecture management. Both documents maintain their instructional tone and content integrity, with no alterations to underlying functionality.

Changes

File Path	Change Summary
docs/user/adaptive-learning/adaptive-learning-instructor.rst	Refined language for clarity regarding linking competencies; maintained sections on managing competencies, prerequisites, and importing methods.
docs/user/lectures.rst	Updated image widths from 800 to 1000 pixels for various images related to lecture management; refined content for clarity without changing logic.

Possibly related PRs

• Development: Add documentation for standardized competencies #8711: This PR adds documentation for standardized competencies, which is directly related to the changes made in adaptive-learning-instructor.rst regarding managing competencies in adaptive learning.
• Adaptive learning: Update documentation to match new mastery calculation #8853: This PR updates the documentation in adaptive-learning-instructor.rst to reflect new metrics for student competencies, which aligns with the main PR's focus on managing competencies.
• Development: Update programming exercise docs for integrated code lifecycle #9509: Although primarily focused on programming exercise documentation, it includes enhancements that may relate to the overall instructional content, similar to the changes made in the main PR.

Suggested labels

ready for review, small

Suggested reviewers

• BBesrour
• JohannesStoehr
• Jan-Thurner

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fdc2501 and 3de52a5.

⛔ Files ignored due to path filters (32)

• docs/user/adaptive-learning/instructor/competency-edit.png is excluded by !**/*.png, !**/*.png
• docs/user/adaptive-learning/instructor/competency-recommendation.png is excluded by !**/*.png, !**/*.png
• docs/user/exams/instructor/programming_assessment.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/modeling/create-modeling-exercise-form-3.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/CodeEditor.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/course-management-template-solution-diff-example.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/instructor-editor.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/online-editor-assessment.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/online-editor-feedback.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/programming-edit-status.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/programming/programming-options-problem-statement.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/quiz/drag-and-drop-question.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/quiz/multiple-choice-question.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/quiz/short-answer-question.png is excluded by !**/*.png, !**/*.png
• docs/user/exercises/text/create-text-exercise-form-2.png is excluded by !**/*.png, !**/*.png
• docs/user/icl/local-vc/commit-diff-view.png is excluded by !**/*.png, !**/*.png
• docs/user/icl/local-vc/current-repository-content-view.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/automatic-unit-processing.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-attachment-unit.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-exercise-unit.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-lecture.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-online-unit.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-text-unit.png is excluded by !**/*.png, !**/*.png
• docs/user/lectures/create-video-unit.png is excluded by !**/*.png, !**/*.png
• docs/user/markdown-support/markdown-lecture-example.png is excluded by !**/*.png, !**/*.png
• docs/user/markdown-support/markdown-lecture-preview.png is excluded by !**/*.png, !**/*.png
• docs/user/markdown-support/markdown-post-extensions-preview.png is excluded by !**/*.png, !**/*.png
• docs/user/markdown-support/markdown-post-extensions.png is excluded by !**/*.png, !**/*.png
• docs/user/plagiarism-check/instructor/student-notification.png is excluded by !**/*.png, !**/*.png
• docs/user/tutorialgroups/instructors-tutorial-group-form.png is excluded by !**/*.png, !**/*.png
• src/main/webapp/content/images/feature-overview/instructors/anonymous_assessment.png is excluded by !**/*.png, !**/*.png
• src/main/webapp/content/images/feature-overview/students/code_editor.png is excluded by !**/*.png, !**/*.png

📒 Files selected for processing (2)

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

✅ Files skipped from review due to trivial changes (1)

• docs/user/lectures.rst

🔇 Additional comments (1)

docs/user/adaptive-learning/adaptive-learning-instructor.rst (1)

57-57: LGTM! Minor text improvement.

The removal of "also" makes the sentence more concise while maintaining clarity.

---

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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

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.

[coolchock]

LGTM

[iyannsch]

Screenshots LGTM

[Jan-Thurner]

Updated screenshots lgtm

[JohannesWt]

👍