General: Automatic Student Feedback Documentation
#10272
Conversation
WalkthroughA new section titled "Automatic Student Feedback" has been added to the Changes
Sequence Diagram(s)sequenceDiagram
participant Student as User
participant UI as Modeling Exercise Page
participant Athena as Athena Service
participant Notify as Notification System
Student->>UI: Create diagram and submit feedback request
UI->>Athena: Send diagram for feedback analysis
Athena-->>UI: Return preliminary score and detailed feedback
UI->>Notify: Trigger feedback ready notification
Notify-->>Student: Display feedback and feedback history
Possibly related PRs
Suggested labels
Suggested reviewers
Tip 🌐 Web search-backed reviews and chat
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/user/exercises/modeling.rst (3)
276-285: Step-by-Step Instructions for Requesting Feedback
The "How to Request Automatic Feedback:" section is well structured with a numbered list and a container directive. Each step is clear. As a nitpick, please double-check that the directive’s indentation and formatting are consistent with similar sections in the document to maintain stylistic uniformity.
315-326: Submission History Documentation
The "Submission History" section clearly conveys how students can review previous feedback. As a minor suggestion, consider adding a brief note if there are any prerequisites or specific conditions under which the submission history is available.
327-330: Demo Section Enhancement
The Demo section effectively points to the screencast demonstration. For added clarity, consider briefly stating what users should expect to learn or observe from the demo.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
docs/user/exercises/modeling/automatic-feedback-history.pngis excluded by!**/*.png,!**/*.pngdocs/user/exercises/modeling/automatic-feedback-request-alert.pngis excluded by!**/*.png,!**/*.pngdocs/user/exercises/modeling/automatic-feedback-request-editor.pngis excluded by!**/*.png,!**/*.pngdocs/user/exercises/modeling/automatic-feedback-request-score.pngis excluded by!**/*.png,!**/*.pngdocs/user/exercises/modeling/automatic-feedback-view-detailed.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (1)
docs/user/exercises/modeling.rst(1 hunks)
🔇 Additional comments (8)
docs/user/exercises/modeling.rst (8)
259-261: Section Header Formatting
The new "Automatic Student Feedback" section header is clear and uses an appropriate underline with dashes. Please verify that the underline length fully matches the header text per RST style requirements.
262-266: Effective Use of Admonition (Tip)
The admonition titled "Why Automatic Student Feedback" with the:class: tipis well implemented. It succinctly explains the benefits for large courses.
267-270: Overview Section Clarity
The "Overview:" block clearly outlines how preliminary AI feedback is requested and generated via the Athena Service. Ensure that the inline literalAllow automatic AI preliminary feedback requestsis consistent with terminology used elsewhere in the documentation.
271-274: Emphasizing Key Recommendations with a Note
The note admonition emphasizing the need for comprehensive Grading Instructions and a Sample Solution is clear and informative. This guidance should help users align their configurations with intended grading criteria.
286-290: Figure Directive for Feedback Request Editor
The figure inclusion for the feedback request editor is well defined with appropriate alignment, alternative text, and scaling. Please verify that the referenced image exists in the assets and displays as intended on all target devices.
291-314: Detailed 'Viewing Feedback' Instructions
The "Viewing Feedback" section provides thorough, step-by-step instructions combined with multiple visual cues. The use of container directives and clear alt text in figure directives enhances user guidance.
331-335: Raw HTML Integration for Video Embed
Embedding the demo video via a raw HTML iframe is acceptable. Please ensure that the documentation hosting platform supports raw HTML content so that the iframe renders correctly across all browsers and devices.
337-357: Image Reference Consistency
The block defining image references is well organized and consistent with the rest of the documentation. This method of defining references promotes reuse and clarity throughout the document.
LeonWehrhahn
changed the title
Documentation: Automatic Student Feedback General: Automatic Student Feedback Documentation
There was a problem hiding this comment.
I looked at it at https://artemis-platform--10272.org.readthedocs.build/en/10272/user/exercises/modeling.html#automatic-student-feedback and it is nice and understandable!
Checklist
General
Motivation and Context
Currently there is no documentation regarding the new Automatic Student Feedback.
Description
This PR introduces a new documentation section for Automatic Student Feedback within the Modeling Exercise documentation. The new section is structured to be consistent with other sections and provides:
Steps for Testing
modeling.rstfile in the local documentation build and check that the new Automatic Student Feedback is there and adheres to the documentation guidelinesTestserver 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
Manual Tests
Exam Mode Test
Performance Tests
Test Coverage
Screenshots