fix: Update docs link to point to the quickstart (3539) by Asymtode712 · Pull Request #3548 · formbricks/formbricks

Asymtode712 · 2024-10-12T10:37:27Z

What does this PR do?

This PR updates the "docs" link, which was previously pointing to the Next.js documentation, to now correctly point to the Quickstart guide at https://formbricks.com/docs/app-surveys/quickstart.

Fixes #3539

How should this be tested?

Test A: Navigate to the section with the "docs" link and verify that it now directs to the correct Quickstart guide.

Checklist

Required

Appreciated

If a UI change was made: Added a screen recording or screenshots to this PR
Updated the Formbricks Docs if changes were necessary

Summary by CodeRabbit

New Features
- Updated the documentation link for the "Javascript SDK" integration card to a new resource.
- Moved the "Javascript SDK" integration card to the top of the list for improved visibility.
Bug Fixes
- Ensured the integration cards continue to function correctly with existing logic and user session checks.

vercel · 2024-10-12T10:37:31Z

@Asymtode712 is attempting to deploy a commit to the formbricks Team on Vercel.

A member of the Team first needs to authorize it.

CLAassistant · 2024-10-12T10:37:33Z

All committers have signed the CLA.

coderabbitai · 2024-10-12T10:37:34Z

Walkthrough

The changes in this pull request focus on the Page component within the apps/web/app/(app)/environments/[environmentId]/integrations/page.tsx file. The documentation link for the "Javascript SDK" integration card has been updated to a new URL, and this card has been repositioned to the start of the integrationCards array. The overall logic for rendering integration cards and the component's functionality, including data fetching and error handling, remains unchanged.

Changes

File Path	Change Summary
apps/web/app/(app)/environments/[environmentId]/integrations/page.tsx	Updated documentation link for "Javascript SDK" integration card and moved it to the beginning of the array.

Assessment against linked issues

Objective	Addressed	Explanation
Update docs link to point to the quickstart (3539)	✅

Possibly related PRs

fix: broken redirect links in developer-docs/contributing #3343: Updates redirect links in the developer documentation, potentially related to the documentation link changes.
fix: Oveview Page Redirect and Contributing Section Redirects Links… #3365: Addresses redirect links in documentation, aligning with the updates made in this PR.
fix: sub-navigation sorting in docs #3415: Fixes broken links in documentation, relevant to the focus on updating links for the Javascript SDK integration card.
fix: docs navigation dropdowns with the same title #3488: Involves changes to documentation structure, which could relate to overall improvements mentioned in this PR.

Suggested labels

bug, 🕹️ oss.gg, 🕹️ 50 points

Suggested reviewers

gupta-piyush19

Poem

In the code where bunnies play,
A link was lost, but found today.
To quickstart docs, we hop with glee,
Integrations bright, as bright can be!
With cards aligned, our path is clear,
Let's code and cheer, the change is here! 🐇✨

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?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-10-12T10:37:38Z

Thank you for following the naming conventions for pull request titles! 🙏

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/web/app/(app)/environments/[environmentId]/integrations/page.tsx (1)
Line range hint 196-205: LGTM! Consider a minor readability improvement.

The changes successfully address the issue mentioned in #3539 by updating the docsHref to the correct Quickstart guide. Moving the Javascript SDK card to the beginning of the integrationCards array is a good choice if it's intended to be highlighted.

For improved readability, consider extracting the Javascript SDK card object into a separate constant before adding it to the array. This would make the code more maintainable, especially if the card's properties need to be referenced or modified elsewhere. Here's a suggested refactor:
const javascriptSDKCard = {
  docsHref: "https://formbricks.com/docs/app-surveys/quickstart",
  docsText: "Docs",
  docsNewTab: true,
  connectHref: `/environments/${environmentId}/product/app-connection`,
  connectText: "Connect",
  connectNewTab: false,
  label: "Javascript SDK",
  description: "Integrate Formbricks into your Website or App",
  icon: <Image src={JsLogo} alt="Javascript Logo" />,
  connected: widgetSetupCompleted,
  statusText: widgetSetupCompleted ? "App Connected" : "Not Connected",
};

integrationCards.unshift(javascriptSDKCard);
This approach would make it easier to manage the Javascript SDK card properties if they need to be updated in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6ec748f and e0ba170.

📒 Files selected for processing (1)

apps/web/app/(app)/environments/[environmentId]/integrations/page.tsx (1 hunks)

🧰 Additional context used

oss-gg · 2024-10-12T12:50:35Z

The /assign command can only be used on issues, not on pull requests.

Asymtode712 · 2024-10-12T13:02:53Z

@mattinannt please review and merge this PR if it is good to go

mattinannt

@Asymtode712 thank you very much for fixing this 🚀

Asymtode712 · 2024-10-13T07:23:21Z

@mattinannt please push it to the merge queue again

oss-gg · 2024-10-14T09:38:19Z

Awarding Asymtode712: 50 points 🕹️ Well done! Check out your new contribution on oss.gg/Asymtode712

formbricks#3539 fixed the link

e0ba170

github-actions Bot added bug Something isn't working 🕹️ 50 points 🕹️ oss.gg Community issue via oss.gg labels Oct 12, 2024

coderabbitai Bot reviewed Oct 12, 2024

View reviewed changes

Asymtode712 changed the title ~~formbricks#3539 fixed the link~~ fix: Update docs link to point to the quickstart (3539) Oct 12, 2024

mattinannt approved these changes Oct 13, 2024

View reviewed changes

Merge branch 'main' into main

dcf1aee

mattinannt enabled auto-merge October 13, 2024 06:57

mattinannt added this pull request to the merge queue Oct 13, 2024

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 13, 2024

Merge branch 'main' into main

a6a01f4

Merge branch 'main' into main

c5f1db9

mattinannt added this pull request to the merge queue Oct 14, 2024

github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Oct 14, 2024

mattinannt added this pull request to the merge queue Oct 14, 2024

Merged via the queue into formbricks:main with commit 81361b3 Oct 14, 2024

coderabbitai Bot mentioned this pull request Oct 14, 2024

docs: added contact form article #3558

Merged

12 tasks done

coderabbitai Bot mentioned this pull request Nov 11, 2024

docs: add n8n community node note #4280

Merged

coderabbitai Bot mentioned this pull request Nov 26, 2024

docs: move community from Discord to Github Discussions #4365

Merged

coderabbitai Bot mentioned this pull request Dec 12, 2024

docs: update docs #4449

Merged

This was referenced Feb 14, 2025

fix: broken links and redirect in docs #4741

Merged

fix: integration doc links #4756

Merged

Conversation

Asymtode712 commented Oct 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

How should this be tested?

Checklist

Required

Appreciated

Summary by CodeRabbit

Uh oh!

vercel Bot commented Oct 12, 2024

Uh oh!

CLAassistant commented Oct 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Oct 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

github-actions Bot commented Oct 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

oss-gg Bot commented Oct 12, 2024

Uh oh!

Asymtode712 commented Oct 12, 2024

Uh oh!

mattinannt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Asymtode712 commented Oct 13, 2024

Uh oh!

Uh oh!

oss-gg Bot commented Oct 14, 2024

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Asymtode712 commented Oct 12, 2024 •

edited

Loading

CLAassistant commented Oct 12, 2024 •

edited

Loading

coderabbitai Bot commented Oct 12, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions Bot commented Oct 12, 2024 •

edited

Loading