> 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/help-hub.md).

# Help Hub

{% 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)). Platforms: iOS and Android. [Source on GitHub](https://github.com/snapfix/docs/blob/main/spec/screens/help/help-hub.md).
{% endhint %}

The in-app help menu: it opens the FAQ, Snaptips, help videos, a note that analytics are in the web app, and the contact form.

* **Where:** iOS: side menu "HelpHub", in the "Support" section, opens the "Help Hub" tab of the profile hub ([My profile](https://docs.snapfix.com/how-the-apps-work/screens/account/profile.md)) (ios @ aa31967ac8, `SnapFix/SideMenuVC.swift:628-629`, `:891-897`; `SnapFix/New Profile/MainProfileVC.swift:23`). Android: side menu "HelpHub", in "Support", opens My Profile on its "Help Hub" tab (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/BusinessListingActivity.java:1042-1045`). "Learn More" at the end of the welcome tour also opens it: iOS opens the same screen with its own header, Android a second copy ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md#welcome-tour-ios-and-android)).
* **Who:** every signed-in user. Neither app checks the role or the site. Signed-out users get [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md).
* **Feature:** [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md)

The web has no Help Hub screen. Its side menu's "HelpHub" item, in "Support", opens a menu with "Take A Quick Tour" ([Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md)), "Help Articles", "Training Videos" and "Contact support". The last three open pages of the public help center in a new tab (`/knowledge`, `/knowledge/onboarding-training` and `/knowledge/contact-support-1` on support.snapfix.com), which has broken links (web\_app\_v2 @ 0989b8e685, `src/app/components/side-menu/side-menu.component.html:45-59`, `src/app/components/side-menu/side-menu.component.ts:364-403`). The item's tooltip is "HelpHub". So signed-in web users have no in-app FAQ, help videos or contact form \[[ASK-195](https://github.com/snapfix/docs/blob/main/ASK.md#ask-195-should-signed-in-web-users-get-the-in-app-contact-form)].

## Layout

### iOS

1. **Header.** Only when the screen opens from "Learn More" after the welcome tour: a back button and no title. Inside the profile hub the header is hidden and the hub's tabs sit above the screen (ios @ aa31967ac8, `SnapFix/HelpHubVC.swift:160-167`, `SnapFix/HelpHubNavView.swift:51-53`).
2. **Intro.** "Help, Tips, and Support – All in One Place." The storyboard's design-time text, "Help, tips, and support - all in one place.", is replaced from the string file when the screen loads (`SnapFix/Storyboards/HelpHub.storyboard:55-61`, `Generic Conrolers/GenericLabel.swift:56-63`).
3. **Rows.** Four rows, each with an icon, a title and a description (`SnapFix/HelpHubVC.swift:170-174`). The string file has the titles in capitals; the row shows them in title case (`SnapFix/TblCellHelpHubList.swift:29-33`).
   * "Frequently Asked Questions": "The FAQ section answers common questions to help you quickly find the info you need!"
   * "Snaptips": "Snaptips provide helpful hints about features, showing you what is new and where things are."
   * "Help Videos": "Help videos offer quick, visual guides to navigate the app and understand features."
   * "Analytics": "Use analytics to view reports, and explore dashboards to gain insights and stay informed on your tasks and goals."
4. **"GET IN TOUCH".** A tile below the rows.

The profile hub's tab for this screen reads "Help Hub".

### Android

Two copies of the screen show the same heading, rows and button (android @ 86068bfeea, `app/src/main/res/layout/layout_help_hub_main.xml:14-58`):

* **My Profile's "Help Hub" tab**, which the side menu opens: the heading "Help, Tips, and Support" with "– All in One Place." on a second line, the rows "Frequently asked questions", "Snaptips", "Help Videos" and "Analytics" with the same descriptions as iOS, and a "GET IN TOUCH" button (the string "Get in touch", shown in capitals). The texts come from the string files (`app/src/main/java/gmail/com/snapfixapp/activity/MyProfileActivity.kt:2621-2636`, `app/src/main/res/values/strings.xml:2161`, `:2180-2181`).
* **`HelpHubActivity`**, which only "Learn More" at the end of the welcome tour opens: the rows read "Frequently Asked Questions", "Snaptips", "Help Videos" and "Analytics", and the row texts are written in English in the code (`app/src/main/java/gmail/com/snapfixapp/activity/HelpHubActivity.kt:70-80`, `app/src/main/java/gmail/com/snapfixapp/activity/BusinessListingActivity.java:4793-4797`). Which copy should stay is open \[[ASK-190](https://github.com/snapfix/docs/blob/main/ASK.md#ask-190-which-android-help-hub-should-stay-my-profiles-tab-or-the-separate-screen)].

## Inputs

None.

## Actions

| Action                       | Who                  | What happens                                                                                                                                                                                                                                      | API                                                                                                                                                      |
| ---------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Frequently Asked Questions" | Every signed-in user | Opens the [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md). Android checks the connection first.                                                                                                                             | [`GET /v1/app/help-hub/{category}`](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory) with `faq`, when the FAQ loads |
| "Snaptips"                   | Every signed-in user | Opens the [Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md) page, which has one quick tour card. On Android the card, not the row, opens the "QUICK TOUR" dialog.                                                   | None                                                                                                                                                     |
| "Help Videos"                | Every signed-in user | Opens [Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md).                                                                                                                                                      | None                                                                                                                                                     |
| "Analytics"                  | Every signed-in user | Opens the [analytics note](#analytics-note).                                                                                                                                                                                                      | None                                                                                                                                                     |
| "GET IN TOUCH"               | Every signed-in user | Opens [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md). On Android the form replaces the rows on the same screen.                                                                                          | None until the form is sent                                                                                                                              |
| Back                         | Every signed-in user | iOS: the welcome-tour copy closes; in the profile hub, the hub's back leaves it. Android: from the FAQ, Snaptips, video or form page, back to the rows; from the rows, leaves My Profile or `HelpHubActivity` (`MyProfileActivity.kt:2767-2810`). | None                                                                                                                                                     |

Each row and the button log an analytics event on both apps.

## States

* **Loading:** none. The rows are fixed in the apps.
* **Empty:** none.
* **Error:** none on this screen. The FAQ and the form show their own errors.
* **No permission:** none. Every signed-in user sees all four rows.
* **Offline (mobile):** the rows, Snaptips and the video list open without a connection. The FAQ and the form check first. iOS shows "No Connection" with "You must be connected to the Internet to carry out this task. Please connect and try again." (ios @ aa31967ac8, `AppUtility.swift:4894-4900`). Android shows the same message without a title, and the FAQ row then stays on the rows (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/utils/InternetUtils.java:52-63`, `:78-92`, `MyProfileActivity.kt:2644-2658`).

## Dialogs and sheets

### Analytics note

Both apps show "Get things done." and "Log in to Snapfix on your desktop to access Dashboards, Reports and Data Analytics." with a close button. Each layout also has a "Snapfix Web Login" button whose link, `https://web.snapfix.com/dashboard-report`, is a route the web app does not have, but the button is hidden on both apps and no code shows it (ios @ aa31967ac8, `SnapFix/AnalyticPopupVC.xib:20`, `:176-179`, `SnapFix/AnalyticPopupVC.swift:43-47`; android @ 86068bfeea, `app/src/main/res/layout/dialog_analytics.xml:84-92`, `app/src/main/java/gmail/com/snapfixapp/dialog/AnalyticsInfoDialog.kt:70-80`). The iOS layout hides two more lines, "Snapfix Web for Dashboards," and "Reports and Data Analytics." (`AnalyticPopupVC.xib:128`, `:152`).

### Snaptips and Get in touch

Described on their own screens: [Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md) and [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md).

## Platform differences

| Topic                  | iOS                                                                                                               | Android                                                                                                                                                                                                |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Entry                  | Side menu "HelpHub" opens the profile hub's "Help Hub" tab                                                        | Side menu "HelpHub" opens My Profile's "Help Hub" tab                                                                                                                                                  |
| After the welcome tour | "Learn More" opens this screen with a back header                                                                 | "Learn More" opens the second copy, `HelpHubActivity` \[[ASK-190](https://github.com/snapfix/docs/blob/main/ASK.md#ask-190-which-android-help-hub-should-stay-my-profiles-tab-or-the-separate-screen)] |
| Text source            | String files                                                                                                      | My Profile: string files. `HelpHubActivity`: English in code                                                                                                                                           |
| FAQ row                | "Frequently Asked Questions"                                                                                      | "Frequently asked questions" (My Profile), "Frequently Asked Questions" (`HelpHubActivity`)                                                                                                            |
| Top bar                | A Help Hub button is in the code, but it is always hidden                                                         | None                                                                                                                                                                                                   |
| Contact                | The "GET IN TOUCH" tile. The new side menu covers the old one, whose "Contact Support" link opened a missing page | The "GET IN TOUCH" button                                                                                                                                                                              |


---

# 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/help-hub.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.
