Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Add documentation for modeling exercises in Artemis iOS #8149

Merged
merged 11 commits into from
Apr 5, 2024

Conversation

AlexanderG2207
Copy link
Member

@AlexanderG2207 AlexanderG2207 commented Mar 6, 2024

Checklist

General

Motivation and Context

Since modeling capabilities were added to the Artemis iOS app, documentation regarding participating in modeling exercises, viewing submissions, and viewing feedback is needed.

Description

I added a sub-section to the Mobile Applications section in the documentation called Modeling Exercises, which explains how users can utilize the modeling functionality within the Artemis iOS app. This includes videos that are hosted on TUM-Live.

Steps for Testing

Check out the Modeling Exercises section under Mobile Applications. Link to Documentation

Testserver States

Note

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







Summary by CodeRabbit

  • New Features
    • Enhanced modeling exercise functionality in the Artemis iOS app, allowing users to participate in exercises, view submissions, and access feedback and grading via new sections: Participate in Modeling Exercise, View Modeling Exercise Submission, and View Modeling Exercise Result.

@AlexanderG2207 AlexanderG2207 self-assigned this Mar 6, 2024
@artemis-bot artemis-bot added this to In progress in Artemis Development Mar 6, 2024
@AlexanderG2207 AlexanderG2207 marked this pull request as ready for review March 6, 2024 15:50
@AlexanderG2207 AlexanderG2207 requested a review from a team as a code owner March 6, 2024 15:50
Copy link

coderabbitai bot commented Mar 6, 2024

Walkthrough

The update introduces an enhanced feature in the Artemis iOS app, focusing on interactive modeling exercises. Users can now actively engage in exercises by participating, submitting their work, and receiving feedback and grading directly within the app. The new functionality enriches the user experience with the ability to add and manipulate UML elements, edit relationships between them, and submit diagrams for evaluation, making learning more interactive and accessible on mobile devices.

Changes

File Path Change Summary
docs/user/mobile-applications.rst Added functionality related to modeling exercises in the Artemis iOS app, enabling users to participate in exercises, view submissions, and check feedback and grading. Three main sections were introduced: Participate in Modeling Exercise, View Modeling Exercise Submission, and View Modeling Exercise Result.

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

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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/coderabbit-overrides.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.

@artemis-bot artemis-bot moved this from In progress to Ready for review in Artemis Development Mar 6, 2024
Artemis Development automation moved this from Ready for review to Review in progress Mar 6, 2024
coderabbitai[bot]
coderabbitai bot previously requested changes Mar 6, 2024
docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@b-fein b-fein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me content-wise.

I left suggestions with two alternatives to improve the formatting.

docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
Copy link

@AntonGeTUM AntonGeTUM left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation and videos lgtm, only one minor suggestion

docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
Co-authored-by: Benedikt Fein <fein@fim.uni-passau.de>
b-fein
b-fein previously approved these changes Mar 9, 2024
muradium
muradium previously approved these changes Mar 11, 2024
mateusmm01
mateusmm01 previously approved these changes Mar 11, 2024
Copy link
Contributor

@mateusmm01 mateusmm01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@AlexanderG2207 AlexanderG2207 dismissed coderabbitai’s stale review March 11, 2024 17:41

Changes were implemented

egekurt123
egekurt123 previously approved these changes Mar 12, 2024
Copy link
Contributor

@egekurt123 egekurt123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Documentation text LGTM

@krusche krusche modified the milestones: 6.9.4, 6.9.5 Mar 19, 2024
@krusche krusche modified the milestones: 6.9.5, 7.0.0 Mar 30, 2024
coderabbitai[bot]
coderabbitai bot previously requested changes Apr 4, 2024
docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
docs/user/mobile-applications.rst Show resolved Hide resolved
docs/user/mobile-applications.rst Outdated Show resolved Hide resolved
docs/user/mobile-applications.rst Show resolved Hide resolved
b-fein
b-fein previously approved these changes Apr 4, 2024
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@AlexanderG2207 AlexanderG2207 dismissed coderabbitai’s stale review April 4, 2024 21:31

Implemented some recommendations

@krusche krusche merged commit e6be12d into develop Apr 5, 2024
13 of 14 checks passed
@krusche krusche deleted the docs/artemis-ios-modeling branch April 5, 2024 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Artemis Development
  
Review in progress
Development

Successfully merging this pull request may close these issues.

None yet

9 participants