Deep linking to articles from your app

Keep your users in the flow by showing them the right help content exactly when and where they need it. With Fernand's deep linking feature, you can create contextual help that appears right within your app without sending users to external documentation or support sites!

Linking to an article

Adding deep links to your support widget is as simple as including a data attribute.

  1. Find your article's slug in the article editor sidebar or from the URL of your article

  2. Add the data-fernand-article="your-article-slug" attribute to your <a> link attribute

  3. Set the value, here with the placeholder your-article-slug to your article's slug. You find this on the article editor right sidebar, under the field URL slug

Here's a basic example:

<a href="javascript:;" data-fernand-article="deep-linking-to-articles-from-your-app">Read our guide on how to deep link to articles</a>

Linking to a collection

Want to direct users to a particular collection of articles? You can use the data-fernand-collection attribute to specify a collection path. Make sure you start the path with a forward slash

Here's a basic example:

<a href="javascript:;" data-fernand-collection="/features/support-widget/">Support widget documentation</a>

Best practices for deep linking

  • Place help triggers near potentially confusing features or steps in your user journey

  • Use deep links in error messages to provide immediate guidance on how to resolve issues

  • Add contextual help in complex forms or during important workflows to prevent user frustration

  • You can automatically open the widget without having the user click on a link by calling the Fernand('open') JS function

  • When using data-fernand-collection, remember to start the path with a forward slash

Was this helpful?