Updated embedded-catalog component readme #318
Conversation
|
WalkthroughThis update introduces a new feature for 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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (1)
- apps/embedded-catalog/react/README.md (2 hunks)
Additional comments: 1
apps/embedded-catalog/react/README.md (1)
- 35-43: The documentation for the
optionalApiUrlprop is clear and informative. However, ensure that the example code snippet is syntactically correct and follows best practices.
| @@ -1,7 +1,7 @@ | |||
|
|
|||
| ## Embedded Catalog of Providers (React) | |||
|
|
|||
| It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click ! | |||
| It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click! | |||
There was a problem hiding this comment.
The preposition "in" might be less appropriate here. Consider using "on" for better readability.
- It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click!
+ It is a React component aimed to be used on any of your pages so end-users can connect their 3rd parties in 1-click!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.
| It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click! | |
| It is a React component aimed to be used on any of your pages so end-users can connect their 3rd parties in 1-click! |
| - The `optionalApiUrl` is an optional prop to use the component with the self-hosted version of Panora. | ||
|
|
||
| ```bash | ||
| <PanoraProviderCard | ||
| name={"hubspot"} # name of the provider | ||
| projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} # the project id tied to your organization | ||
| returnUrl={"https://acme.inc"} # the url you want to redirect users to after the connection flow is successful | ||
| linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"} # the linked id of the user if already created in Panora system or user's info in your system | ||
| name={"hubspot"} // name of the provider | ||
| projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} // the project id tied to your organization | ||
| returnUrl={"https://acme.inc"} // the url you want to redirect users to after the connection flow is successful | ||
| linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"} // the linked id of the user if already created in Panora system or user's info in your system | ||
| optionalApiUrl={"http://localhost:3000"} // Only add this prop to use the component with a self-hosted version of Panora. Without this prop, the component uses the cloud version of Panora. |
There was a problem hiding this comment.
In the code snippet, there's an unnecessary space before the closing parenthesis of the PanoraProviderCard component. While this might not affect the functionality, it's best to follow consistent formatting.
- />
+ />Note: This change is purely stylistic and does not impact functionality.
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.
| - The `optionalApiUrl` is an optional prop to use the component with the self-hosted version of Panora. | |
| ```bash | |
| <PanoraProviderCard | |
| name={"hubspot"} # name of the provider | |
| projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} # the project id tied to your organization | |
| returnUrl={"https://acme.inc"} # the url you want to redirect users to after the connection flow is successful | |
| linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"} # the linked id of the user if already created in Panora system or user's info in your system | |
| name={"hubspot"} // name of the provider | |
| projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} // the project id tied to your organization | |
| returnUrl={"https://acme.inc"} // the url you want to redirect users to after the connection flow is successful | |
| linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"} // the linked id of the user if already created in Panora system or user's info in your system | |
| optionalApiUrl={"http://localhost:3000"} // Only add this prop to use the component with a self-hosted version of Panora. Without this prop, the component uses the cloud version of Panora. | |
| <PanoraProviderCard | |
| name={"hubspot"} // name of the provider | |
| projectId={"c9a1b1f8-466d-442d-a95e-11cdd00baf49"} // the project id tied to your organization | |
| returnUrl={"https://acme.inc"} // the url you want to redirect users to after the connection flow is successful | |
| linkedUserId={"b860d6c1-28f9-485c-86cd-fb09e60f10a2"} // the linked id of the user if already created in Panora system or user's info in your system | |
| optionalApiUrl={"http://localhost:3000"} // Only add this prop to use the component with a self-hosted version of Panora. Without this prop, the component uses the cloud version of Panora. |
|
|
||
| ## Embedded Catalog of Providers (React) | ||
|
|
||
| It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click ! | ||
| It is a React component aimed to be used in any of your pages so end-users can connect their 3rd parties in 1-click! | ||
|
|
||
| ## Installation | ||
|
|
There was a problem hiding this comment.
📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [24-24]
Consider capitalizing file types for consistency and clarity.
- # Import the css file
+ # Import the CSS file
Summary by CodeRabbit
PanoraProviderCardcomponent for users to specify a self-hosted version of Panora, enhancing flexibility and customization.