Communication: Add feature availability list to user documentation
#10015
Conversation
julian-wls
added
small
communication
WalkthroughThe pull request introduces significant updates to the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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: 1
🧹 Outside diff range and nitpick comments (1)
docs/user/communication.rst (1)
330-334: Improve organization of platform-specific notes.The notes section mixes implementation details with user-facing information.
Consider:
- Moving implementation details to developer documentation.
- Organizing platform-specific notes in a more structured format:
Platform-Specific Features ------------------------- Web App ^^^^^^^ - Leave chat available for groups only - Image download through browser iOS ^^^^ - Leave chat for groups and non course-wide channels - Group chat creation via 'Create Chat' Android ^^^^^^^ - Leave chat for channels, groups, and DMs - Group chat creation via 'Create Chat'
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/user/communication.rst(1 hunks)
🔇 Additional comments (1)
docs/user/communication.rst (1)
155-319: Enhance feature table clarity and tracking.
The feature availability table could benefit from the following improvements:
- Consider adding version numbers or target release dates for features marked as WIP or PLANNED.
- Structure the "Actor Restrictions" column consistently using bullet points:
-| Pin Messages | Groups: group creators |
+| Pin Messages | • Groups: group creators |
There was a problem hiding this comment.
Looking good!
It would be good to also mention this section in the Mobile Applications page. I think a short info like "For the most up-to-date feature availability status, check [link]" would be enough :D
|
github-actions
bot
added
the
deployment-error
HawKhiem
added
deploy:artemis-test3
and removed
deployment-error
|
github-actions
bot
added
the
deployment-error
julian-wls
dismissed stale reviews from asliayk, PaRangger, FelberMartin, and coderabbitai[bot]
via
ff9a5d2
github-actions
bot
removed
the
communication
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
docs/user/communication.rst (1)
332-336: Consider adding visual separation for implementation notesWhile the notes provide valuable clarification, consider adding a visual separator (like a horizontal rule) before the note section to improve readability.
+---- + .. note:: - Leave chat option is available on the web app for groups only, on iOS for groups and non course-wide channels, and on Android for channels, groups, and DMs.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/user/communication.rst(1 hunks)docs/user/mobile-applications.rst(1 hunks)
🔇 Additional comments (3)
docs/user/mobile-applications.rst (1)
13-13: LGTM: Well-integrated cross-reference
The added cross-reference to the communication features list enhances documentation connectivity and helps users find relevant information.
docs/user/communication.rst (2)
109-127: Consider improving status badges implementation
The current implementation using raw HTML with inline styles could be improved for better maintainability and accessibility.
157-321: LGTM: Well-structured feature availability documentation
The table effectively documents feature availability across platforms with:
- Clear categorization of features
- Explicit actor restrictions
- Consistent status indicators
- Platform-specific implementation status
|
HawKhiem
added
deploy:artemis-test2
and removed
deployment-error
|
github-actions
bot
added
the
deployment-error
julian-wls
added
ready to merge
and removed
deployment-error
Checklist
General
Motivation and Context
As discussed in the last communication meeting the a list of available features should be made publically available to make it easier for users to compare available features for each platform.
Description
This PR adds a table to the communication documentation (docs/user/communication.rst) and introduces labels that are placed next to each feature to show what the status of feature is on the web app, iOS app and Android app.
Status labels are AVAILABLE, UNAVAILABLE, WIP, PLANNED and NOT PLANNED.
Steps for Testing
Prerequisites:
1 Student
Navigate to the communication documentation and verify that there is a new section called Communication Features Availability with a table that explains each status and another table containing a row for each feature.
Testserver States
Note
These badges show the state of the test servers.
Green = Currently available, Red = Currently locked
Click on the badges to get to the test servers.
Review Progress
Code Review
Manual Tests
Summary by CodeRabbit
Summary by CodeRabbit