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

# FAQ

{% 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/faq.md).
{% endhint %}

Signed-in users read and search answers to common questions.

* **Where:** iOS: Help Hub > "Frequently Asked Questions". Android: Help Hub > "Frequently asked questions" on My Profile's tab, or "Frequently Asked Questions" on the second Help Hub screen \[[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)] ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md)). The web has no FAQ for signed-in users.
* **Who:** every signed-in user. No role or site check. Signed-out users get the same list on [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md), which on iOS is this screen in its signed-out mode.
* **Feature:** [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md)

The articles are the server's FAQ category `faq` ([Help article object](https://docs.snapfix.com/engineering-reference/api/help.md#help-article-object)). Production serves the server's built-in FAQ file, so every platform shows the same articles, and none of them is about signing in. With the HubSpot source the answers would arrive as one string that neither app reads, so the list would fail to load, and each load would fetch every article page ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory)).

## Layout

### iOS

1. **Header.** A back button and "FAQ" (ios @ aa31967ac8, `SnapFix/FaqVC.swift:87`, `SnapFix/HelpHubVC.swift:96-99`).
2. **Title and intro.** "Frequently asked questions" and "Find answers to common questions here. Our FAQ section covers key topics to help you get the most out of the app, troubleshoot issues, and learn about all available features." (`SnapFix/FaqVC.swift:80-82`).
3. **Search.** A field with the placeholder "Search for help topics" and a clear button (`SnapFix/Storyboards/HelpHub.storyboard:370`, `SnapFix/FaqVC.swift:94-101`).
4. **List.** One row per article, showing its title. A tap shows the answer: the description, a blank line, then each content line. Another tap hides it (`SnapFix/FaqVC.swift:37-44`, `:166-170`).

### Android

1. **Title and intro.** "Frequently Ask Questions", the layout's default text, which this screen never replaces, and the same intro as iOS (android @ 86068bfeea, `app/src/main/res/layout/layout_faq_main.xml:12-32`).
2. **Loading.** A logo animation while the list loads.
3. **Search.** A box with the hint "Search for help topics".
4. **List.** As on iOS: a tap shows or hides the description, a blank line and the content lines (`app/src/main/java/gmail/com/snapfixapp/adapter/FAQAdapter.kt:32-58`).

## Inputs

| Field                    | Type | Required | Default | Rules and messages                                                                                                                                                                                                                                                                                                                                                      |
| ------------------------ | ---- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| "Search for help topics" | Text | No       | Empty   | Filters the loaded list as the user types; no request. Matches the title, the description or a content line, ignoring case. iOS trims spaces first; Android matches the text as typed. An empty search shows every article. No match shows an empty list with no message (ios @ aa31967ac8, `SnapFix/FaqVC.swift:94-116`; android @ 86068bfeea, `FAQAdapter.kt:81-94`). |

## Actions

| Action          | Who                  | What happens                                                                                                                     | API                                                                                                                       |
| --------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| Open the screen | Every signed-in user | Loads the articles of category `faq`.                                                                                            | [`GET /v1/app/help-hub/{category}`](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory) |
| Search          | Every signed-in user | Filters the list.                                                                                                                | None                                                                                                                      |
| Tap an article  | Every signed-in user | Shows or hides its answer, and logs the article's title with an analytics event.                                                 | None                                                                                                                      |
| Back            | Every signed-in user | iOS: closes the screen. Android: returns to the Help Hub rows and cancels a load in progress (`MyProfileActivity.kt:2767-2780`). | None                                                                                                                      |

## States

* **Loading:** iOS: a "Refreshing..." overlay. Android: the logo animation, with the search box hidden until the answer arrives (`MyProfileActivity.kt:2644-2652`).
* **Empty:** neither app shows text when there are no articles.
* **Error:** iOS: an alert with the API's message, or "Something went wrong. Please try again.", and "Ok"; the list stays empty (`SnapFix/FaqVC.swift:137-141`). Android: no message; the animation stops and the list stays empty. After an expired session Android gets a new token and loads again (`app/src/main/java/gmail/com/snapfixapp/activity/HelpHubActivity.kt:423-431`).
* **No permission:** none.
* **Offline (mobile):** iOS shows "No Connection" with "You must be connected to the Internet to carry out this task. Please connect and try again." and loads nothing (`SnapFix/FaqVC.swift:119-121`). Android shows the same message without a title and stays on the Help Hub rows (`MyProfileActivity.kt:2644-2658`).

## Dialogs and sheets

None.

## Platform differences

| Topic       | iOS                          | Android                                                 |
| ----------- | ---------------------------- | ------------------------------------------------------- |
| Title       | "Frequently asked questions" | "Frequently Ask Questions"                              |
| Header      | "FAQ" with a back button     | The Help Hub's toolbar                                  |
| Search      | Trims spaces, then matches   | Matches as typed                                        |
| Errors      | Alert                        | No message                                              |
| Translation | The text as sent             | Translated when the site has AI language translation on |

Android shows each question and answer as sent, then replaces it with a translation into the app's language when the selected site has AI language translation on. The translation comes from [`POST /v1/app/translations/batch`](https://docs.snapfix.com/engineering-reference/api/reference.md), and the search still matches the original text. iOS and the web always show the API's English text \[[ASK-191](https://github.com/snapfix/docs/blob/main/ASK.md#ask-191-should-the-faq-be-translated-on-ios-and-the-web-as-on-android)] (`FAQAdapter.kt:35-41`, `app/src/main/java/gmail/com/snapfixapp/utils/TranslationBinder.kt:25-48`, `app/src/main/java/gmail/com/snapfixapp/utils/TranslationManager.kt:146-150`, `:246-265`, `app/src/main/java/gmail/com/snapfixapp/repository/TranslationRepository.kt:53-54`).


---

# 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/faq.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.
