Skip to content

Latest commit

 

History

History
204 lines (171 loc) · 9.02 KB

quickstart.mdx

File metadata and controls

204 lines (171 loc) · 9.02 KB
title Quickstart
description Install Superflow on your site and leave your first comment.
icon bolt

Superflow installs as a single script on the site you already have. Once it is on the page, you add ?review=true to any URL to bring up the toolbar and start commenting.

![The Superflow toolbar on a live site, with a comment being left on the page](/images/demo.gif) Enter the URL of the site you want to review. Superflow generates a unique script for that project.
<Frame>
  ![Entering a site URL when creating a Superflow project](/images/enter-url-final.png)
</Frame>

<Tip>
  Turn on **Run Agents** here and Superflow starts reviewing the site for spelling, broken links, accessibility and more while you finish the install. See [agent pre-checks](/agents/how-to-run-agent-pre-checks-on-a-new-project).
</Tip>
Pick your platform below. Every install guide opens with a video walkthrough, then repeats it as steps with a screenshot for each click.
<Frame>
  ![Choosing a platform from the list during Superflow onboarding](/images/select-platform-final.png)
</Frame>
Click **Verify** in the onboarding flow. Superflow opens your published site and confirms the script is live.
<Frame>
  ![The Superflow installation verified confirmation message](/images/verified-final.png)
</Frame>

<Warning>
  Not verifying? The usual causes are unsaved custom code, an unpublished site, a cached page, a missing `?review=true`, a staging URL when you are checking production, or the script installed twice.
</Warning>
Open your site with `?review=true` at the end of the URL, for example `mywebsite.com/?review=true`. The toolbar appears in the bottom right.
<Frame>
  ![The Superflow toolbar in the bottom right of a live website](/images/toolbar-final.png)
</Frame>

You can comment by highlighting text, hovering an element, or drawing a box anywhere on the page, and you can record a voice note or your screen instead of typing.

Pick your platform

Next

Superflow installs as a single script on the site you already have. Once it is on the page, you add ?review=true to any URL to bring up the toolbar and start commenting.

![The Superflow toolbar on a live site, with a comment being left on the page](/images/demo.gif) Enter the URL of the site you want to review. Superflow generates a unique script for that project.
<Frame>
  ![Entering a site URL when creating a Superflow project](/images/enter-url-final.png)
</Frame>

<Tip>
  Turn on **Run Agents** here and Superflow starts reviewing the site for spelling, broken links, accessibility and more while you finish the install. See [agent pre-checks](/agents/how-to-run-agent-pre-checks-on-a-new-project).
</Tip>
Pick your platform below. Every install guide opens with a video walkthrough, then repeats it as steps with a screenshot for each click.
<Frame>
  ![Choosing a platform from the list during Superflow onboarding](/images/select-platform-final.png)
</Frame>
Click **Verify** in the onboarding flow. Superflow opens your published site and confirms the script is live.
<Frame>
  ![The Superflow installation verified confirmation message](/images/verified-final.png)
</Frame>

<Warning>
  Not verifying? The usual causes are unsaved custom code, an unpublished site, a cached page, a missing `?review=true`, a staging URL when you are checking production, or the script installed twice.
</Warning>
Open your site with `?review=true` at the end of the URL, for example `mywebsite.com/?review=true`. The toolbar appears in the bottom right.
<Frame>
  ![The Superflow toolbar in the bottom right of a live website](/images/toolbar-final.png)
</Frame>

You can comment by highlighting text, hovering an element, or drawing a box anywhere on the page, and you can record a voice note or your screen instead of typing.

Pick your platform

Next

Describe a check in plain English and let Superflow run it against your siteDescribe a check in plain English and let Superflow run it against your site. All installation and agent videos on one pageAll installation and agent videos on one page.