add documentation for message model and effects #585
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds documentation for message effects and data models while also updating the menus to include new entries for messaging functionality.
- Adds a Markdown file detailing the Message effect including its attributes, validations, caveats, effect methods, and example usage.
- Introduces documentation for Message data models, transmission channels, and attachments.
- Updates the menus configuration to include new sections for Message effects and data.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| collections/_sdk/effects/message.md | Documentation for the Message effect including usage examples. |
| collections/_sdk/data/message.md | Documentation for the Message data models. |
| _data/menus.yml | Menu configuration updated with new entries for Messages. |
Comments suppressed due to low confidence (1)
_data/menus.yml:585
- [nitpick] Ensure that the YAML menu items maintain consistent indentation with existing entries to adhere to the project formatting standards.
- title: "Messages"
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
nmpsilva
commented
May 23, 2025
aduane
approved these changes
May 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://canvasmedical.atlassian.net/browse/KOALA-2802