Development: Update documentation for private messages and search filters

[egekurt123]

Checklist

General

• I tested all changes and their related features with all corresponding user types on a test server.
• 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.

Description

This pull request addresses the necessary updates to the documentation regarding private messaging and message searching.

Further comprehensive updates will follow after the new UI change PRs are merged.

Code Review

• Review 1
• Review 2
• Review 3

Summary by CodeRabbit

• New Features

  • Added sorting options for message searches based on Creation Date.
  • Enabled channel-specific searches within the communications module.

• Enhancements

  • Updated private messaging availability to depend on course instructor settings.
  • Refined the Direct Messages Enabled / Group Chats checkbox for better management of group chats and direct messages.

• Removed

  • Eliminated the ability to search by Message ID and Context filters like Lecture, Exercise, Course-wide topics.

[coderabbitai]

Walkthrough

The changes refine communication settings in Artemis courses, focusing on better management of direct messages and group chats, updating private message availability based on instructor settings, and enhancing message search functionalities by removing specific filters and adding sorting and channel-specific search capabilities.

Changes

File	Change Summary
docs/user/communication.rst	Updated communication feature toggles, refined private messaging checks, and streamlined message searches.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CourseInstructor
    participant CommunicationModule

    User->>CommunicationModule: Search messages in channel
    CommunicationModule-->>User: Display search results (sorted by Creation Date)

    User->>CourseInstructor: Request to enable private messaging
    CourseInstructor-->>CommunicationModule: Enable private messaging feature
    CommunicationModule-->>User: Private messaging enabled

    User->>User: Direct Messages and Group Chats managed through updated settings

Loading

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between a9450cf and 8693ea8.

Files selected for processing (1)

• docs/user/communication.rst (4 hunks)

Additional comments not posted (4)

docs/user/communication.rst (4)

21-21: Clarify the checkbox description for better readability.

The description of the Direct Messages Enabled / Group Chats checkbox can be made clearer by rephrasing it.

- respective checkbox (``Communication Enabled``) - it can also be edited afterwards. Additionally, you can enable or disable group chats and direct messages by checking the (``Direct Messages Enabled / Group Chats``) checkbox.
+ respective checkbox (``Communication Enabled``), which can also be edited afterwards. Additionally, you can enable or disable group chats and direct messages by checking the (``Direct Messages Enabled / Group Chats``) checkbox.

---

68-68: Clarify the availability of private communication.

The description of the availability of private communication can be made clearer by rephrasing it.

- Private communication is only available if the course instructor enables this feature.
+ Note: Private communication is only available if the course instructor enables this feature.

---

117-117: Remove outdated search criteria references.

Ensure that the outdated search criteria references are removed to avoid confusion.

- * Text-based search
-    * Contents of Announcement-Message Title
-    * Contents of Message Context

---

126-127: Clarify the channel-specific search description.

The description of how to search within a specific channel can be made clearer by rephrasing it.

- To search within a specific channel in the communications module, users can navigate to the desired channel and utilize the search bar located in that channel.
+ To search within a specific channel in the communications module, navigate to the desired channel and use the search bar located in that channel.

---

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.

[JohannesStoehr]

The build of the documentation currently fails (see GitHub checks at the bottom of the PR page).
Can you also provide the link to the changed documentation page? Once the documentation build again, you can open it in via the GitHub checks

[coderabbitai]

Actionable comments posted: 4

[egekurt123]

The build of the documentation currently fails (see GitHub checks at the bottom of the PR page). Can you also provide the link to the changed documentation page? Once the documentation build again, you can open it in via the GitHub checks

This is not the case anymore.