Skip to content

docs: add MessageList Markdown example #4315

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

Open
wants to merge 2 commits into
base: latest
Choose a base branch
from

Conversation

tomivirkki
Copy link
Member

Add documentation for the MessageList component Markdown support

Related to vaadin/platform#7601

Copy link

github-actions bot commented May 15, 2025

AI Language Review

The changes made to the file appear to be mostly additions, which include new sections on "Markdown" support and "Usage for AI Chats" with examples for implementation. These additions are generally accurate and clear; however, ensure that the thematic consistency of the document is maintained across these new sections. The integration of versioning notes with [role="since:com.vaadin:[email protected]"] is appropriate for specifying the availability of features. Additionally, the reference to "HTML tags" as supported in Markdown should emphasize the sanitization safeguard to prevent security issues further.

No specific corrections are necessary for the lines added; the information is clear and follows the existing documentation style appropriately.

There are no significant issues with the code snippets or descriptions provided.

Overall, the improvements in the document enhance the clarity and completeness of the information regarding new features and usage recommendations.

@tomivirkki tomivirkki requested a review from rolfsmeds May 16, 2025 06:44
You can configure the Message List to format the messages in Markdown instead of plain text.
Message List can be configured to support formatting messages in Markdown instead of plain text.
Copy link
Member

Choose a reason for hiding this comment

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

Why the change to passive style, which we specifically discourage?

Copy link
Member Author

Choose a reason for hiding this comment

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

Wasn't sure so took some inspiration from some of the most recently added documentation. I can revert the style change.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we specifically discourage passive style? Technical documentation is commonly written in passive, after all, and the alternative tends to lead to half of all sentences starting with "You"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants