Skip to content

Conversation

wenxi-onyx
Copy link
Member

@wenxi-onyx wenxi-onyx commented Sep 17, 2025

Description

add docs link to the main connector creation page (previously only show on credential creation screen)

How Has This Been Tested?

[Describe the tests you ran to verify your changes]

Backporting (check the box to trigger backport action)

Note: You have to check that the action passes, otherwise resolve the conflicts manually and tag the patches.

  • This PR should be backported (make sure to check that the backport attempt succeeds)
  • [Optional] Override Linear Check

Summary by cubic

Adds a docs link to the main connector creation page so users can access setup instructions earlier. Also consolidates docs link rendering into a reusable component.

  • New Features

    • Show a “docs” link on AddConnectorPage for the selected source (opens in a new tab, hidden if no link).
  • Refactors

    • Introduced ConnectorDocsLink component and replaced inline link in CreateCredential.

@wenxi-onyx wenxi-onyx requested a review from a team as a code owner September 17, 2025 22:38
Copy link

vercel bot commented Sep 17, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
internal-search Ready Ready Preview Comment Sep 17, 2025 10:51pm

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR introduces a reusable ConnectorDocsLink component to provide documentation links throughout the connector creation flow. The change extracts the previously hardcoded documentation link from the credential creation screen and creates a dedicated component that can be used consistently across multiple locations.

The implementation adds three key changes:

  1. New ConnectorDocsLink component - A clean, reusable component that renders documentation links using the existing getSourceDocLink utility. It displays the text "Check out our docs for more info on configuring this connector" with proper styling and handles cases where no documentation is available.
  2. Refactored CreateCredential component - Replaces the inline documentation link JSX with the new ConnectorDocsLink component, removing code duplication and improving maintainability.
  3. Enhanced AddConnectorPage - Adds the documentation link to form step 1 (connector configuration), ensuring users have access to help documentation during the main configuration phase, not just during credential creation.

This change improves the user experience by providing consistent access to connector documentation at multiple points in the setup flow, while following DRY principles and creating a single source of truth for documentation link rendering.

Confidence score: 5/5

  • This PR is safe to merge with minimal risk as it only involves UI improvements and component refactoring
  • Score reflects simple, well-structured changes that improve code reusability without affecting core functionality
  • No files require special attention as the changes are straightforward component extractions and additions

3 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

1 issue found across 3 files

Prompt for AI agents (all 1 issues)

Understand the root cause of the following 1 issues and fix them.


<file name="web/src/components/admin/connectors/ConnectorDocsLink.tsx">

<violation number="1" location="web/src/components/admin/connectors/ConnectorDocsLink.tsx:24">
target=&quot;_blank&quot; is missing rel=&quot;noopener noreferrer&quot;, which is a security risk (reverse tabnabbing).</violation>
</file>

React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.

Check out
<a
className="text-blue-600 hover:underline"
target="_blank"
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot Sep 17, 2025

Choose a reason for hiding this comment

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

target="_blank" is missing rel="noopener noreferrer", which is a security risk (reverse tabnabbing).

Prompt for AI agents
Address the following comment on web/src/components/admin/connectors/ConnectorDocsLink.tsx at line 24:

<comment>target=&quot;_blank&quot; is missing rel=&quot;noopener noreferrer&quot;, which is a security risk (reverse tabnabbing).</comment>

<file context>
@@ -0,0 +1,33 @@
+      Check out
+      &lt;a
+        className=&quot;text-blue-600 hover:underline&quot;
+        target=&quot;_blank&quot;
+        href={docsLink}
+      &gt;
</file context>
Fix with Cubic

@wenxi-onyx wenxi-onyx force-pushed the whuang/docs-link-on-connector-creation branch from 291920e to 9c9bd71 Compare September 17, 2025 22:48
@wenxi-onyx wenxi-onyx disabled auto-merge September 18, 2025 00:06
@wenxi-onyx wenxi-onyx merged commit 898b8c3 into main Sep 18, 2025
54 of 55 checks passed
@wenxi-onyx wenxi-onyx deleted the whuang/docs-link-on-connector-creation branch September 18, 2025 00:06
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.

2 participants