Add Camino Messenger Account and Partner configuration to glossary #317
Conversation
There was a problem hiding this comment.
@VjeraTurk can we also squeeze in the change to the faucet docs here? Mention that the current max amount is 150CAM per week (instead of the old 50CAM a day), with a disclaimer that it's subject to changes and that the discord bot will always reflect the latest and most correct amount/time https://github.com/chain4travel/camino-docs/blob/dev/docs/developer/guides/how-to-deploy-a-smart-contract.md#3-request-funds-from-the-discord-faucet
I've added that to the other docs PR |
docs/faq/glossary.md
Outdated
|
|
||
| The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. | ||
| It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. | ||
|
|
||
| ## Camino Messenger Protocol |
There was a problem hiding this comment.
move "Camino Messenger Protocol" to before "Partner Plugin"
There was a problem hiding this comment.
@SamJaarsma I'm not sure what you mean
I see that
Camino Messenger Protocol line 89
Partner Plugin line 448
But I did notice that "Camino Messenger Account" was below "Camino Messenger Bot", so I changed that.
docs/faq/glossary.md
Outdated
|
|
||
| The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. | ||
| It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. | ||
|
|
There was a problem hiding this comment.
The Camino Messenger Account can be created from the Partner Showroom of the Camino Suite or - for development purposes on Columbus only - by using a script
More details can be found in our functional documentation: Camino Partner Showroom
There was a problem hiding this comment.
I would avoid mentioning the script if it is only meant/encouraged to be used for development purposes (test accounts). Or we mention that here.
If it's ok that mainnet account are created via hardhat, we can keep it but switch the link to c4t branch once the dev is merged.
There was a problem hiding this comment.
Agreed that live accounts should not be used for Camino, only for development on Columbus. Updated the suggestion to include that
docs/faq/glossary.md
Outdated
| ## Partner Configuration | ||
|
|
||
| The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger. | ||
|
|
||
| ## Partner plugin | ||
|
|
||
| The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate |
There was a problem hiding this comment.
| The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate | |
| The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate with the Partner distribution or inventory system. | |
| More details can be found in our functional documentation: [Camino Messenger Bot Partner Plugin](https://docs.camino.network/camino-messenger/bot/partner-plugin/ "Camino Messenger Bot Partner Plugin") |
There was a problem hiding this comment.
@SamJaarsma this link is invalid:
https://docs.camino.network/partners/partner-plugin
Did you mean this one: https://docs.camino.network/camino-messenger/bot/partner-plugin/ ?
Co-authored-by: Sam Jaarsma C4T <[email protected]>
|
Warning Rate limit exceeded@VjeraTurk has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 5 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 Walkthrough📝 Walkthrough📝 WalkthroughWalkthroughThe changes in the pull request focus on enhancing the glossary section of the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Glossary
User->>Glossary: Request for definitions
Glossary-->>User: Provide definitions for "Camino Messenger Account" and "Partner Configuration"
User->>Glossary: Ask for acronym clarification
Glossary-->>User: Provide "CMA" for "Camino Messenger Account"
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)
docs/faq/glossary.md (2)
84-88: Remove extra blank lines to maintain consistent formatting.While the content is informative and well-written, the entry contains extra blank lines that deviate from the document's formatting style. Other entries don't have these extra spaces.
Apply this diff to fix the formatting:
## Camino Messenger Account - - The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. -
444-447: Add missing newline before next section header.The content and documentation link are excellent. However, there's a formatting issue where the "Partner plugin" section header immediately follows this entry without proper spacing.
Apply this diff to fix the formatting:
The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger. More details can be found in our functional documentation: [Camino Partner Configuration](https://docs.camino.network/partners/partner-config "Camino Partner Configuration") + ## Partner plugin
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/faq/glossary.md(3 hunks)
🔇 Additional comments (2)
docs/faq/glossary.md (2)
20-20: LGTM! Acronym addition is well-formatted.
The "CMA" acronym is correctly placed in alphabetical order and follows the established format.
84-88: LGTM! New entries maintain high documentation standards.
The new entries for "Camino Messenger Account" and "Partner Configuration" are well-written, maintaining consistent style with the rest of the glossary. They provide clear technical explanations and proper cross-referencing.
Also applies to: 444-447
Co-authored-by: Sam Jaarsma C4T <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
docs/faq/glossary.md (3)
84-88: Consider incorporating additional context and linksWhile the content is technically accurate, consider incorporating the following suggestions from previous reviews:
- Add information about account creation through Partner Showroom
- Include relevant documentation links
## Camino Messenger Account The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. + +The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners) or by using a [script](https://github.com/chain4travel/camino-messenger-bot?tab=readme-ov-file#camino-messenger-account-cm-account) + +More details can be found in our functional documentation: [Camino Partner Showroom](https://docs.camino.network/partners/partner-showroom "Camino Partner Showroom")
446-449: Consider adding the documentation linkThe entry provides a clear explanation. Consider adding the documentation link as suggested in previous reviews.
## Partner Configuration The Partner Configuration allows Partners to make themselves known to the Camino Network as service providers, or as looking for services from other Partners in the Network. Upon matching between services wanted and offered by two parties, such services will be then traded on Camino Messenger. +More details can be found in our functional documentation: [Camino Partner Configuration](https://docs.camino.network/partners/partner-config "Camino Partner Configuration")
441-444: Fix grammar and consider adding documentation link
- Add a comma after "products" to improve readability
- Consider adding the suggested documentation link
-planning and booking various travel-related services and products often offering a +planning and booking various travel-related services and products, often offering a wide range of options and choices from different suppliers. + +More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)🧰 Tools
🪛 LanguageTool
[uncategorized] ~441-~441: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/faq/glossary.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/faq/glossary.md
[uncategorized] ~441-~441: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
docs/faq/glossary.md (1)
20-20: LGTM: Acronym entry follows the established format
The new CMA acronym entry is properly formatted and correctly placed in alphabetical order.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
docs/faq/glossary.md (1)
84-91: Maintain consistent formatting with other entries.While the content is accurate and well-explained, the entry contains extra blank lines that are inconsistent with the formatting of other entries in the glossary.
Apply this diff to maintain consistency:
## Camino Messenger Account - - The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. - The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners) - More details can be found in our functional documentation: [Camino Partner Showroom](https://docs.camino.network/partners/partner-showroom "Camino Partner Showroom") -
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/faq/glossary.md(3 hunks)
🔇 Additional comments (2)
docs/faq/glossary.md (2)
20-22: LGTM: Acronym additions are well-formatted and properly ordered.
The new acronym "CMA" and the retained "CMP" are correctly formatted, properly linked to their respective sections, and maintain alphabetical ordering.
450-455: LGTM: Partner Configuration entry is well-structured and informative.
The entry provides clear explanation of Partner Configuration's role in the Camino Network, with proper formatting and valid documentation links.
docs/faq/glossary.md
Outdated
| planning and booking various travel-related services and products often offering a | ||
| wide range of options and choices from different suppliers. | ||
|
|
||
| More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction) |
There was a problem hiding this comment.
Remove unrelated documentation link from OTA entry.
The link to Camino Messenger Protocol Documentation appears to be incorrectly placed within the OTA (Online Travel Agency) definition. This documentation link seems unrelated to the OTA concept and should be removed or moved to a more appropriate section.
Apply this diff to fix the issue:
planning and booking various travel-related services and products often offering a
wide range of options and choices from different suppliers.
-
-More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| planning and booking various travel-related services and products often offering a | |
| wide range of options and choices from different suppliers. | |
| More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction) | |
| planning and booking various travel-related services and products often offering a | |
| wide range of options and choices from different suppliers. |
There was a problem hiding this comment.
@VjeraTurk @SamJaarsma this looks valid to me, why we have it under OTA section?
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
There was a problem hiding this comment.
Yes I agree, line 448 should be included below line 97
docs/faq/glossary.md
Outdated
| planning and booking various travel-related services and products often offering a | ||
| wide range of options and choices from different suppliers. | ||
|
|
||
| More details can be found in our functional documentation: [Camino Messenger Protocol Documentation](https://docs.camino.network/camino-messenger/introduction) |
There was a problem hiding this comment.
Yes I agree, line 448 should be included below line 97
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (1)
docs/faq/glossary.md (1)
84-91: Consider restructuring the development tool information.The explanation of the Camino Messenger Account is clear, but the development tool information could be better separated from the main concept explanation.
Consider this structure:
## Camino Messenger Account The Camino Messenger Account is a smart contract (actually an ensemble of smart contracts), acting as the financial backbone of the [Partner Configuration](#partner-configuration), holding the funds designated for trading on behalf of the Partner on the Camino Messenger, and paying / receiving payment amounts for bookings. It also stores all configuration settings such as the services offered and wanted (and their versions), the applicable service fees and the accepted currencies. It also maintains a list of the wallets of the off-chain bots with which the Partner's systems interact with the Messenger. -The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners) or - for development purposes on Columbus only - by using a [cli tool](https://github.com/chain4travel/camino-messenger-bot?tab=readme-ov-file#camino-messenger-account-cm-account) +### Creation +The Camino Messenger Account can be created from the Partner Showroom of the [Camino Suite](https://suite.camino.network/partners). + +> **Note for Developers**: For development and testing purposes on Columbus network only, accounts can also be created using the [cli tool](https://github.com/chain4travel/camino-messenger-bot?tab=readme-ov-file#camino-messenger-account-cm-account). More details can be found in our functional documentation: [Camino Partner Showroom](https://docs.camino.network/partners/partner-showroom "Camino Partner Showroom")
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/faq/glossary.md(3 hunks)
🔇 Additional comments (2)
docs/faq/glossary.md (2)
20-22: LGTM: Acronyms are properly ordered and consistent.
The addition of the CMA acronym maintains alphabetical order and follows the established format.
450-454: LGTM: Clear and well-structured Partner Configuration entry.
The entry provides a clear explanation of the concept and includes appropriate documentation links.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
docs/faq/glossary.md (2)
447-448: Add missing comma and improve sentence structureThe current sentence structure needs improvement for better readability.
Apply this change:
-planning and booking various travel-related services and products often offering a +planning and booking various travel-related services and products, often offering a🧰 Tools
🪛 LanguageTool
[uncategorized] ~447-~447: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...(AI_HYDRA_LEO_MISSING_COMMA)
458-464: Improve sentence structure with proper punctuationThe sentence structure needs improvement for better readability.
Apply this change:
-The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to integrate with the Partner distribution or inventory system. +The Partner Plugin serves as a bridge, enabling the Camino Messenger Bot to integrate with the Partner distribution or inventory system.🧰 Tools
🪛 LanguageTool
[uncategorized] ~458-~458: Possible missing comma found.
Context: ... plugin The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to in...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
docs/faq/glossary.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/faq/glossary.md
[uncategorized] ~447-~447: Possible missing comma found.
Context: ...ing various travel-related services and products often offering a wide range of options ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~458-~458: Possible missing comma found.
Context: ... plugin The Partner Plugin serves as a bridge enabling the Camino Messenger Bot to in...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
docs/faq/glossary.md (3)
20-22: LGTM: Acronym additions are well-organized
The new acronym entries are properly formatted and maintain alphabetical ordering.
71-78: LGTM: Well-structured and comprehensive definition
The Camino Messenger Account entry provides clear and detailed information about its role, functionality, and setup process. The distinction between production and development environments is properly documented.
450-454: LGTM: Clear and concise definition
The Partner Configuration entry effectively explains its purpose and relationship with the Camino Network.
Small PR suggested by @nkoljanin
Summary by CodeRabbit
New Features
Documentation