docs(readme): add special configuration when using Spring #126
Conversation
WalkthroughThe changes involve the addition of a new section in the Changes
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
CodeRabbit Configuration File (
|
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
README.md (2)
99-99: Consider rephrasing for concisenessThe current wording "For this reason, the add-on might need to be allowed in order to display correctly" could be more concise.
Consider revising to:
- For this reason, the add-on might need to be allowed in order to display correctly. + Therefore, you may need to explicitly allow the add-on for correct display.🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
96-105: Add context for the configuration requirementTo help users better understand the necessity of this configuration, consider adding a brief explanation of why it's specifically required for this add-on.
You could add a sentence like:
This configuration is necessary because this add-on's components are located outside the default Vaadin scanning path.This additional context will help users understand the purpose of the configuration and why it's specific to this add-on.
🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~99-~99: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
🔇 Additional comments (1)
README.md (1)
96-105: Excellent addition of Spring configuration instructions!The new section provides valuable information for users integrating this add-on with Spring. The explanation, instructions, and example are clear and helpful.
🧰 Tools
🪛 LanguageTool
[style] ~99-~99: Consider a shorter alternative to avoid wordiness.
Context: ...on, the add-on might need to be allowed in order to display correctly.To do so, just a...
(IN_ORDER_TO_PREMIUM)
Summary by CodeRabbit
vaadin.allowed-packagesproperty and provided an example configuration line.