Adding Bot documentation suggestions after Decode Antalya #323
Conversation
|
Note Reviews pausedUse the following commands to manage reviews:
📝 Walkthrough📝 Walkthrough📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe documentation for the Camino Messenger Bot has been updated in two main areas: configuration and installation. The configuration documentation now includes additional guidance on running the bot, notes on potential breaking changes, and enhanced clarity regarding wallet requirements. The installation documentation introduces sections on known issues and networking requirements, detailing specific problems users may face and providing solutions. These updates aim to improve user understanding and operational success when utilizing the bot. Changes
Poem
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 (5)
docs/camino-messenger/bot/installation.mdx (3)
37-37: Fix grammatical error in the introduction sentenceThe sentence structure is incorrect.
-The Camino Messenger Bot the following known issues should be considered: +The following known issues should be considered when using the Camino Messenger Bot:
54-56: Improve clarity of Docker restart instructionThe workaround instruction should be more specific and use proper verb form.
-If the Partner Plugin is disconnected and the bot receives a message, the Bot - may crash. To workaround that, use --restart always when running the docker - container. +If the Partner Plugin is disconnected and the bot receives a message, the Bot + may crash. To work around this issue, add the `--restart always` flag when running + the Docker container.🧰 Tools
🪛 LanguageTool
[grammar] ~55-~55: The word “workaround” is a noun. The verb is spelled with a white space.
Context: ...ives a message, the Bot may crash. To workaround that, use --restart always when running...(NOUN_VERB_CONFUSION)
66-73: Improve readability of connection scenariosThe connection scenarios would be clearer with better formatting and punctuation.
Bot-Plugin connection scenarios: -In case the bot is running from docker container and plugin on localhost: In the - bot configuration of the plugin host we write "host.docker.internal". -In case the bot is running from docker container and plugin on docker container: - In the bot configuration of the plugin host we write service name of the plugin - which is used in docker compose. -In case the bot is running from the executable on localhost and plugin as well: - In the bot configuration of the plugin host we write "localhost". +1. Bot in Docker container, plugin on localhost: + - In the bot configuration, set the plugin host to "host.docker.internal" + +2. Bot in Docker container, plugin in Docker container: + - In the bot configuration, set the plugin host to the service name used in docker-compose + +3. Bot and plugin both running on localhost: + - In the bot configuration, set the plugin host to "localhost"🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...n the bot configuration of the plugin host we write "host.docker.internal". - In c...(AI_HYDRA_LEO_MISSING_COMMA)
docs/camino-messenger/bot/configuration.mdx (2)
31-33: Improve grammar in configuration version warningThe sentence about release compatibility needs an article and better structure.
-`.example` at the end. Pay attention to use the correct version of the -configuration file. If release is introducing configuration incompatibility, -we'll describe it in release notes. +`.example` at the end. Pay attention to use the correct version of the +configuration file. If a release introduces configuration incompatibility, +we'll describe it in the release notes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing article found.
Context: ...t version of the configuration file. If release is introducing configuration incompatib...(AI_HYDRA_LEO_MISSING_A)
31-33: Add cross-reference to Known Issues sectionConsider adding a reference to the Known Issues section from the installation document to help users anticipate potential configuration-related issues.
`.example` at the end. Pay attention to use the correct version of the configuration file. If a release introduces configuration incompatibility, -we'll describe it in the release notes. +we'll describe it in the release notes. For a list of current known issues, +refer to the [Known Issues](installation#known-issues) section in the installation guide.🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: Possible missing article found.
Context: ...t version of the configuration file. If release is introducing configuration incompatib...(AI_HYDRA_LEO_MISSING_A)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
docs/camino-messenger/bot/configuration.mdx(1 hunks)docs/camino-messenger/bot/installation.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/camino-messenger/bot/configuration.mdx
[uncategorized] ~32-~32: Possible missing article found.
Context: ...t version of the configuration file. If release is introducing configuration incompatib...
(AI_HYDRA_LEO_MISSING_A)
docs/camino-messenger/bot/installation.mdx
[uncategorized] ~47-~47: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...er Plugin should sanitize empty messages and we might implement validation for emp...
(COMMA_COMPOUND_SENTENCE)
[grammar] ~55-~55: The word “workaround” is a noun. The verb is spelled with a white space.
Context: ...ives a message, the Bot may crash. To workaround that, use --restart always when running...
(NOUN_VERB_CONFUSION)
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...n the bot configuration of the plugin host we write "host.docker.internal". - In c...
(AI_HYDRA_LEO_MISSING_COMMA)
|
@coderabbitai ignore |
✅ Actions performedReviews paused. |
SamJaarsma
force-pushed
the
sam/add-known-issues
branch
from
c83d5d7 to
a55f167
Compare
|
@SamJaarsma @Noctunus I've updated the pages and also pushed this branch to docs playground. Please review. |
LGTM |
Added known issues, networking and warning on correct configuration file with bot version
Summary by CodeRabbit