Skip to main content

Auto-update images in help center

You can use Solo to automate updating images in your help center. When Solo detects an inaccurate image, it will navigate your product, capture an updated image of the UI, and then notify you to approve and publish the replacement image.

Teaching Solo to capture images

Set up a login flow

As a one-time set up, you need to teach Solo how to log into your product. To do that, navigate to Documentation -> Images and add a new login flow. You will need to provide the following details:

  • Name: A descriptive name for the login flow.

  • Start URL: The web address of your login page.

  • Feature description: The instructions Solo follows to log in. When you write the feature description for a login flow, you must include the username and password.

Tip: Solo does not support multi-factor authentication (MFA). Also, use credentials for a sandbox or demo account.

Identifying outdated images

When Solo encounters an outdated image, it will automatically suggest a replacement if it's seen that image before. However, if this is Solo's first time identifying an outdated image, Solo will ask you to teach it how to find its replacement. To do that, Solo will ask you to create an image flow

Image flows tell Solo how to navigate to a specific feature and capture a screenshot.

Create an image flow

To create an image flow, describe to Solo what needs to be captured in the image. Solo will then navigate to that screen and capture the image. Afterward, Solo will show you a preview of the image so you can verify the instructions worked.

  • Login flow: Select the login flow Solo should use to access your product.

  • Start URL: The web address where Solo should begin navigation after it logs in.

  • Feature description: The instructions Solo follows to find the feature.

Tips for writing a good flow prompt

The feature description serves as the prompt that guides Solo through your product. To write an effective prompt:

  • Be direct and list the exact steps Solo should take.

  • Use the exact names of buttons, menus, or links as they appear in your product.

  • Specify the final screen Solo needs to reach to capture the image.

Viewing image flow history

To troubleshoot a flow, navigate to Documentation -> Images -> select a flow -> History page. On this page, you will see:

  • Verify date: the date the flow ran

  • Run status: the result of the flow when Solo tried to capture the image

  • Images compared: the image that was captured from your flow

  • Session replay: a video of Solo's AI navigating your product to capture the image


Did this answer your question?