Dev

[EvickaStudio]

This pull request includes updates to the documentation, configuration, and versioning for the MoodleMate application. The most important changes are the addition of screenshots to the README, updating the Docker configuration to use named volumes, and incrementing the application version.

Documentation updates:

• README.md: Added a new "Screenshots" section with images for versions 2.0.2 and 2.0.1, and provided instructions for viewing logs when running as a Docker daemon.

Configuration updates:

• docker-compose.yml: Updated the Docker configuration to use a named volume moodlemate_logs for storing logs.

Versioning update:

• src/core/version.py: Incremented the application version from 2.0.1 to 2.0.2.

Summary by Sourcery

Update documentation with screenshots, update Docker configuration to use named volumes, and increment the application version.

Enhancements:

• Update the Docker configuration to use a named volume moodlemate_logs for storing logs.

Documentation:

• Add a new 'Screenshots' section to the README with images for versions 2.0.2 and 2.0.1, and provide instructions for viewing logs when running as a Docker daemon.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request updates the documentation by adding screenshots and instructions for viewing logs when running as a Docker daemon. It also updates the Docker configuration to use named volumes and increments the application version.

Updated class diagram for the version

classDiagram
    class Version {
        - __version__ : str
    }
    note for Version "Version has been updated from 2.0.1 to 2.0.2"

Loading

File-Level Changes

Change	Details	Files
Added screenshots and instructions for viewing logs when running as a Docker daemon to the README.	Added a 'Screenshots' section with images for versions 2.0.2 and 2.0.1. Provided instructions for viewing logs when running as a Docker daemon.	README.md
Updated the Docker configuration to use a named volume for storing logs.	Replaced the bind mount for the logs directory with a named volume 'moodlemate_logs'.	docker-compose.yml
Incremented the application version.	Updated the version from 2.0.1 to 2.0.2.	src/core/version.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @EvickaStudio - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using a consistent image format for the screenshots in the README (e.g., prefer .png over .webp).
• It might be helpful to include a brief description of what the screenshots are showing, rather than just the version number.

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}