> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/how-the-apps-work/screens/help.md).

# Help screens

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/help/README.md).
{% endhint %}

Help for people who use Snapfix and for people who cannot sign in: the apps' Help Hub with its FAQ, help videos, Snaptips and contact form, the sign-in help page, and the quick tour.

On iOS and Android the Help Hub is a tab of the profile hub ([My profile](https://docs.snapfix.com/how-the-apps-work/screens/account/profile.md)). The web has no Help Hub screen: its side menu's "HelpHub" item offers the quick tour and links to the public help center. The sign-in and password screens link to [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md). The FAQ and the contact form use the [Help API](https://docs.snapfix.com/engineering-reference/api/help.md); help videos and Snaptips make no API calls.

| Screen                                                                                        | Platforms         | Where                                                                                                    |
| --------------------------------------------------------------------------------------------- | ----------------- | -------------------------------------------------------------------------------------------------------- |
| [Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md)               | ios, android      | iOS and Android: side menu "HelpHub", which opens the profile hub's "Help Hub" tab                       |
| [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md)                         | ios, android      | iOS and Android: Help Hub > "Frequently Asked Questions" ("Frequently asked questions" on Android's tab) |
| [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md) | web, ios, android | web `/auth/help-hub-faq`; all platforms: the "HelpHub." link on the sign-in and password screens         |
| [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md)       | web, ios, android | web `/auth/get-in-touch`, from Help with logging in; iOS and Android: Help Hub, and Help with logging in |
| [Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md)               | web, ios, android | web: side menu "HelpHub" > "Take A Quick Tour"; iOS and Android: Help Hub > "Snaptips"                   |
| [Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md)         | ios, android      | iOS and Android: Help Hub > "Help Videos"                                                                |


---

# 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.snapfix.com/how-the-apps-work/screens/help.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.
