Development: Document the manual assessment of programming exercises

[pzdr7]

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

Manual assessment in the code editor was not documented. Recent changes in #8921 modified the user interface.

Description

• Added a section about manual assessment in the online code editor based on Programming exercises: Improve styling of feedback and manual assessment #8921
• Linked to the individual exercise pages from the generic Assessment section

Steps for Testing

Added a note: https://artemis-platform--8968.org.readthedocs.build/en/8968/user/assessment.html#manual-assessment

Added a section: https://artemis-platform--8968.org.readthedocs.build/en/8968/user/exercises/programming.html#manual-assessment

Review Progress

• Code Review 1
• Code Review 2

Screenshots

Refer to the documentation

Summary by CodeRabbit

• Documentation
  • Restructured the explanation of manual assessment in Artemis.
  • Enhanced documentation for file uploads with improved structure and navigation elements.
  • Added a new section for manual assessment in the online editor for programming exercises, detailing features like file browsing, build output display, read-only code editor, feedback addition, and assessment finalization.
  • Introduced reference links for better navigation in various exercise documents (modeling, textual).

The base branch was changed.

[coderabbitai]

Walkthrough

The recent changes primarily enhance the documentation for various exercise types within Artemis. These enhancements focus on improving manual assessment explanations and adding reference links for better navigation. Importantly, a new section detailing the manual assessment process in the online editor for programming exercises has been introduced. This offers a comprehensive guide on providing feedback, adding comments, and finalizing assessments using the online editor interface.

Changes

Files	Change Summary
docs/user/assessment.rst	Restructured the explanation of manual assessment, emphasizing general concepts and specific exercise types.
docs/user/exercises/file-upload.rst	Added a reference marker file-upload at the beginning of the document to improve navigation.
docs/user/exercises/modeling.rst	Added a reference link _modeling to introduce a new section or anchor point for navigation.
docs/user/exercises/textual.rst	Added a reference link _textual at the beginning of the document to enhance navigational structure.
docs/user/exercises/programming.rst	Introduced a new section on manual assessment in the online editor, detailing features and processes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant OnlineEditor
    participant BuildSystem
    participant FeedbackSystem
    
    User->>OnlineEditor: Open Programming Exercise
    OnlineEditor-->>User: Display Files, Build Output
    
    User->>OnlineEditor: Provide Feedback/Comments
    OnlineEditor->>BuildSystem: Display Build Output
    BuildSystem-->>OnlineEditor: Return Build Output
    
    User->>OnlineEditor: Add Feedback, Comments
    
    OnlineEditor->>FeedbackSystem: Submit Feedback and Comments
    FeedbackSystem-->>OnlineEditor: Confirmation of Submission
    OnlineEditor-->>User: Feedback Submitted Successfully

Loading

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between aa8a382 and 9187371.

Files selected for processing (1)

• docs/user/exercises/programming.rst (1 hunks)

Additional comments not posted (7)

docs/user/exercises/programming.rst (7)

143-145: LGTM!

The description of the saving process and finalizing the assessment is clear and provides sufficient context for the reader.

---

146-162: LGTM!

The image references for various buttons used in the online editor are correct and provide sufficient context for the reader.

---

161-162: LGTM!

The content under "Repository Access" is clear and provides sufficient context for the reader.

---

119-119: Clarify the build output description.

The sentence "The build output shows the output of the build process, if any." can be expanded for clarity.

- The build output shows the output of the build process, if any.
+ The build output shows the output of the build process, if any. This is useful in case of build errors.

Likely invalid or redundant comment.

---

104-108: Clarify the alternative methods for manual assessment.

The sentence "Alternatively, you can use the online editor to assess the students' submissions." can be expanded for clarity.

- Alternatively, you can use the online editor to assess the students' submissions.
+ Alternatively, you can use the online editor within Artemis to assess the students' submissions directly in the browser.

Likely invalid or redundant comment.

---

132-132: Clarify the process for entering feedback comments and scores.

The sentence "After clicking the button, you can enter a feedback comment and a score for the selected line." can be expanded for clarity.

- After clicking the button, you can enter a feedback comment and a score for the selected line.
+ After clicking the |add-feedback-button| button, you can enter a feedback comment and assign a score for the selected line.

Likely invalid or redundant comment.

---

116-116: Ensure the general feedback button is clearly described.

The sentence "For manual assessment, the online editor provides the following features tailored to the assessment process:" can be expanded for clarity.

- For manual assessment, the online editor provides the following features tailored to the assessment process:
+ For manual assessment, the online editor provides the following features tailored to the assessment process, which include:

Likely invalid or redundant comment.

---

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

[coderabbitai]

Actionable comments posted: 4

[JohannesStoehr]

Looks good to me now

[Jan-Thurner]

New Documentation LGTM

[florian-glombik]

Approve

Found one misplaced comma, and left a few comments that are not blocking are merge from my point of view

[coderabbitai]

Actionable comments posted: 3

[coderabbitai]

Actionable comments posted: 2

[florian-glombik]

Thanks for the changes - re-approve

[edkaya]

Changes in doc look good to me