> For the complete documentation index, see [llms.txt](https://docs.userlane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.userlane.com/assistance/in-app-guidance.md).

# In-app guidance

Guides, validators, tooltips, Contextual Actions, and the selectors underneath them.

In-app guidance is help that appears inside the application someone is already working in. Userlane draws it on top of the existing screen, and the underlying application is not changed.

Each page below covers one type. Guides walk a user through a process step by step. Validators check an entry before it is saved. Tooltips and beacons attach a short explanation or a marker to a single element on screen. Contextual Actions show content automatically when a condition is met. Selectors[^1] are the mechanism underneath all of them, and the reason a piece of content sometimes stops finding its element after the application changes.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><picture><source srcset="https://259567114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6bxg8i3T6U4vZ3k7PHi%2Fuploads%2FzLwzqyH4T63HtYlB2N9l%2Fcompass__white.png?alt=media&#x26;token=b54cf2e1-f688-4b94-8a11-94588269c785" media="(prefers-color-scheme: dark)"><img src="https://259567114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6bxg8i3T6U4vZ3k7PHi%2Fuploads%2FiHyNNdGs4eqjjzd2fx3I%2Fcompass.png?alt=media&#x26;token=7c753fbb-ed18-433d-b2ce-bb2c5526c921" alt="" data-size="line"></picture></td><td><h4>Creating selectors</h4></td><td><a href="/assistance/in-app-guidance/creating-selectors.md">Creating selectors</a></td></tr><tr><td><picture><source srcset="https://259567114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6bxg8i3T6U4vZ3k7PHi%2Fuploads%2FMIjjkLFjMP8n2olF860Z%2Fchecked-off__white.png?alt=media&#x26;token=55dbc676-97df-47ea-a8b0-ac1634197db5" media="(prefers-color-scheme: dark)"><img src="https://259567114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FF6bxg8i3T6U4vZ3k7PHi%2Fuploads%2FFD4yEIdpAtZmfGjw0SCR%2Fchecked-off.png?alt=media&#x26;token=76ee17de-ea9f-4eeb-a99e-82fdb4fe0417" alt="" data-size="line"></picture></td><td><h4>Creating validators</h4></td><td><a href="/assistance/in-app-guidance/validators.md">Creating validators</a></td></tr></tbody></table>

{% content-ref url="/pages/1S0Ysrf45iMPMs4rp5yk" %}
[Creating guides](/assistance/in-app-guidance/creating-guides.md)
{% endcontent-ref %}

{% content-ref url="/pages/KhbHHZ0ThLa5Pkd5bNXI" %}
[Creating tooltips](/assistance/in-app-guidance/creating-tooltips.md)
{% endcontent-ref %}

{% content-ref url="/pages/L1pTwQHW0TmAMoPDFhLR" %}
[Creating Contextual Actions](/assistance/in-app-guidance/creating-contextual-actions.md)
{% endcontent-ref %}

## Relevant articles

* [A tour of the Editor](/assistance/a-tour-of-the-editor.md)
* [Targeting](/assistance/content-operations/targeting.md)
* [Tasks](/intelligence/tasks.md)
* [Guides: build, maintain, and make them effective](/best-practices/guides-build-maintain-and-make-them-effective.md)

[^1]: A selector is the rule Userlane uses to find an element on the page. If the application changes, the selector may need refining so it still matches.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.userlane.com/assistance/in-app-guidance.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
