From 78bb8a005ea8a14ae61d5fe8e74cdb1fbead15ca Mon Sep 17 00:00:00 2001 From: ShubhamPalriwala Date: Wed, 30 Aug 2023 17:04:45 +0530 Subject: [PATCH] fix: add link to examples, fix heading white in light mode, update docs as per poc built in examples repo --- .../app/docs/api/api-key-setup/page.mdx | 2 +- .../cancel-subscription/page.mdx | 6 +- .../best-practices/docs-feedback/page.mdx | 4 +- .../best-practices/feature-chaser/page.mdx | 4 +- .../docs/best-practices/feedback-box/page.mdx | 20 +- .../best-practices/improve-trial-cr/page.mdx | 6 +- .../best-practices/interview-prompt/page.mdx | 8 +- .../docs/best-practices/pmf-survey/page.mdx | 6 +- .../getting-started/framework-guides/page.mdx | 195 +++++++++--------- .../app/docs/integrations/zapier/page.mdx | 4 +- .../link-surveys/data-prefilling/page.mdx | 2 +- 11 files changed, 127 insertions(+), 130 deletions(-) diff --git a/apps/formbricks-com/app/docs/api/api-key-setup/page.mdx b/apps/formbricks-com/app/docs/api/api-key-setup/page.mdx index 6ad4ea5f56..755491aeae 100644 --- a/apps/formbricks-com/app/docs/api/api-key-setup/page.mdx +++ b/apps/formbricks-com/app/docs/api/api-key-setup/page.mdx @@ -32,7 +32,7 @@ The API requests are authorized with a personal API key. This API key gives you /> - ## Store API key safely {{ class: "text-white" }} + ## Store API key safely Anyone who has your API key has full control over your account. For security reasons, you cannot view the API key again. diff --git a/apps/formbricks-com/app/docs/best-practices/cancel-subscription/page.mdx b/apps/formbricks-com/app/docs/best-practices/cancel-subscription/page.mdx index 5d81009940..9e54fc4c98 100644 --- a/apps/formbricks-com/app/docs/best-practices/cancel-subscription/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/cancel-subscription/page.mdx @@ -45,7 +45,7 @@ To run the Churn Survey in your app you want to proceed as follows: 4. Prevent that churn! - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? We assume that you have already installed the Formbricks Widget in your web app. It’s required to display messages and surveys in your app. If not, please follow the [Quick Start Guide (takes 15mins max.)](/docs/getting-started/quickstart-in-app-survey) @@ -118,7 +118,7 @@ Whenever a user visits this page, matches the filter conditions above and the re Here is our complete [Actions manual](/docs/actions/why) covering [Code](/docs/actions/code) and [No-Code](/docs/actions/no-code) Actions. - ## Pre-churn flow coming soon {{ class: "text-white" }} + ## Pre-churn flow coming soon We’re currently building full-screen survey pop-ups. You’ll be able to prevent users from closing the survey unless they respond to it. It’s certainly debatable if you want that but you could force them to click through the survey before letting them cancel 🤷 @@ -156,7 +156,7 @@ These settings make sure the survey is always displayed, when a user wants to Ca /> - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Churn Survey in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/best-practices/docs-feedback/page.mdx b/apps/formbricks-com/app/docs/best-practices/docs-feedback/page.mdx index 217423bae8..035128799c 100644 --- a/apps/formbricks-com/app/docs/best-practices/docs-feedback/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/docs-feedback/page.mdx @@ -72,7 +72,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t 5. In the same way, you can change the Internal Question ID of the _Please elaborate_ question to **“additionalFeedback”** and the one of the _Page URL_ question to **“pageUrl”**. - ## Answers need to be identical {{ class: "text-white" }} + ## Answers need to be identical If you want different answers than “Yes 👍” and “No 👎” you need update the choices accordingly. They have to be identical to the frontend we're building in the next step. @@ -110,7 +110,7 @@ To get this running, you'll need a bit of time. Here are the steps we're going t ### 2. Build the frontend - ## Your frontend might work differently {{ class: "text-white" }} + ## Your frontend might work differently Your frontend likely looks and works differently. This is an example specific to our tech stack. We want to illustrate what you should consider building yours 😊 diff --git a/apps/formbricks-com/app/docs/best-practices/feature-chaser/page.mdx b/apps/formbricks-com/app/docs/best-practices/feature-chaser/page.mdx index cd24bde7bf..74db0313a6 100644 --- a/apps/formbricks-com/app/docs/best-practices/feature-chaser/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/feature-chaser/page.mdx @@ -42,7 +42,7 @@ To run the Feature Chaser survey in your app you want to proceed as follows: 2. Setup a user action to display survey at the right point in time - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? We assume that you have already installed the Formbricks Widget in your web app. It’s required to display messages and surveys in your app. If not, please follow the [Quick Start Guide (takes 15mins max.)](/docs/getting-started/quickstart-in-app-survey) @@ -126,7 +126,7 @@ Lastly, scroll down to “Recontact Options”. Here you have full freedom to de Publish survey - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Feature Chaser in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/best-practices/feedback-box/page.mdx b/apps/formbricks-com/app/docs/best-practices/feedback-box/page.mdx index 492de14a4e..b7f60c2cf2 100644 --- a/apps/formbricks-com/app/docs/best-practices/feedback-box/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/feedback-box/page.mdx @@ -74,7 +74,7 @@ Go to the “Audience” tab, find the “When to send” card and choose “Add Add action - ## You can also add actions in your code {{ class: "text-white" }} + ## You can also add actions in your code You can also create [Code Actions](/docs/actions/code) using `formbricks.track("Eventname")` - they will automatically appear in your Actions overview as long as the SDK is embedded. @@ -84,19 +84,9 @@ We have two options to track the Feedback Button in your application: innerText 1. **innerText:** This means that whenever a user clicks any HTML item in your app which has an `innerText` of `Feedback` the Feedback Box will be displayed. 2. **CSS-Selector:** This means that when an element with a specific CSS-Selector like `#feedback-button` is clicked, your Feedback Box is triggered. -
- Add HTML action - Add CSS action +
+ Add HTML action + Add CSS action
### 4. Select action in the “When to ask” card @@ -131,7 +121,7 @@ Scroll down to “Recontact Options”. Here you have to choose the right settin ## Setting up the Widget - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Feedback Box in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/best-practices/improve-trial-cr/page.mdx b/apps/formbricks-com/app/docs/best-practices/improve-trial-cr/page.mdx index 9f03f06a96..b3a8e00d5b 100644 --- a/apps/formbricks-com/app/docs/best-practices/improve-trial-cr/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/improve-trial-cr/page.mdx @@ -42,7 +42,7 @@ To display the Trial Conversion Survey in your app you want to proceed as follow 3. Print that 💸 - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? We assume that you have already installed the Formbricks Widget in your web app. It’s required to display messages and surveys in your app. If not, please follow the [Quick Start Guide (takes 15mins max.)](/docs/getting-started/quickstart-in-app-survey) @@ -78,7 +78,7 @@ Save, and move over to the “Audience” tab. ### 3. Pre-segment your audience (coming soon) - ## Filter by attribute coming soon {{ class: "text-white" }} + ## Filter by attribute coming soon We're working on pre-segmenting users by attributes. We will update this manual in the next days. @@ -135,7 +135,7 @@ Lastly, scroll down to “Recontact Options”. Here you have to choose the corr Publish survey - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Feedback Box in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/best-practices/interview-prompt/page.mdx b/apps/formbricks-com/app/docs/best-practices/interview-prompt/page.mdx index d132257c0c..87f72601a7 100644 --- a/apps/formbricks-com/app/docs/best-practices/interview-prompt/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/interview-prompt/page.mdx @@ -47,7 +47,7 @@ To display an Interview Prompt in your app you want to proceed as follows: 3. That’s it! 🎉 - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? We assume that you have already installed the Formbricks Widget in your web app. It’s required to display messages and surveys in your app. If not, please follow the [Quick Start Guide (15mins).](/docs/getting-started/quickstart-in-app-survey) @@ -90,7 +90,7 @@ Save, and move over to the “Audience” tab. ### 3. Pre-segment your audience (coming soon) - ## Filter by attribute coming soon {{ class: "text-white" }} + ## Filter by attribute coming soon We're working on pre-segmenting users by attributes. We will update this manual in the next few days. @@ -107,7 +107,7 @@ To create the trigger to show your Interview Prompt, go to the “Audience” ta Add action - ## You can also add actions in your code {{ class: "text-white" }} + ## You can also add actions in your code You can also create [Code Actions](/docs/actions/code) using `formbricks.track("Eventname")` - they will automatically appear in your Actions overview as long as the SDK is embedded. @@ -160,7 +160,7 @@ Scroll down to “Recontact Options”. Here you have to choose the correct sett Publish survey - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Feedback Box in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/best-practices/pmf-survey/page.mdx b/apps/formbricks-com/app/docs/best-practices/pmf-survey/page.mdx index 7dbc82fd94..96398afbe3 100644 --- a/apps/formbricks-com/app/docs/best-practices/pmf-survey/page.mdx +++ b/apps/formbricks-com/app/docs/best-practices/pmf-survey/page.mdx @@ -41,7 +41,7 @@ To display the Product-Market Fit survey in your app you want to proceed as foll 3. Setup the user action to display survey at good point in time - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? We assume that you have already installed the Formbricks Widget in your web app. It’s required to display messages and surveys in your app. If not, please follow the [Quick Start Guide (15mins).](/docs/getting-started/quickstart-in-app-survey) @@ -77,7 +77,7 @@ Save, and move over to where the magic happens: The “Audience” tab. ### 3. Pre-segment your audience (coming soon) - ## Filter by attribute coming soon {{ class: "text-white" }} + ## Filter by attribute coming soon We're working on pre-segmenting users by attributes. We will update this manual in the next days. @@ -132,7 +132,7 @@ Lastly, scroll down to “Recontact Options”. Here you have to choose the corr Publish survey - ## Formbricks Widget running? {{ class: "text-white" }} + ## Formbricks Widget running? You need to have the Formbricks Widget installed to display the Feedback Box in your app. Please follow [this tutorial (Step 4 onwards)](/docs/getting-started/quickstart-in-app-survey) to install the widget. diff --git a/apps/formbricks-com/app/docs/getting-started/framework-guides/page.mdx b/apps/formbricks-com/app/docs/getting-started/framework-guides/page.mdx index b169bedc6d..a2a4c1e447 100644 --- a/apps/formbricks-com/app/docs/getting-started/framework-guides/page.mdx +++ b/apps/formbricks-com/app/docs/getting-started/framework-guides/page.mdx @@ -35,39 +35,17 @@ Before getting started, make sure you have: --- -## Validate your setup - -Once you have completed the steps above, you can validate your setup by checking the **Setup Checklist** in the Settings. Your widget status indicator should go from this: - -Widget isnt connected - -To this: - -Widget is connected - -**Can’t figure it out? [Join our Discord!](https://formbricks.com/discord)** - ---- - ## HTML All you need to do is copy a ` + !function(){var t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://unpkg.com/@formbricks/js@^1.0.0/dist/index.umd.js";var e=document.getElementsByTagName("script")[0];e.parentNode.insertBefore(t,e),setTimeout(function(){window.formbricks=window.js;window.formbricks.init({environmentId: "", apiHost: ""})},500)}(); + + ``` @@ -84,7 +62,7 @@ All you need to do is copy a `