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

# Snapfix docs

How Snapfix works today: what the product does, every screen of the web app and the iOS and Android apps, and, for engineers, the API, the database and the infrastructure.

AI agents write these pages from Snapfix's code, its staging database and the live app. No person has checked most of them yet. [How to read these docs](https://docs.snapfix.com/how-to-read.md) explains what that means, and the other marks on a page.

{% hint style="warning" %}
This site is for Snapfix staff only. Never share its pages, links or screenshots outside Snapfix.
{% endhint %}

## Where to start

**New to Snapfix**

* [What Snapfix is](https://docs.snapfix.com/product/product.md): the product on one page, who uses it, and how its main parts fit together.
* [Glossary](https://docs.snapfix.com/product/glossary.md): every term, with the words on the screen and the names in the code.
* [Roles and permissions](https://docs.snapfix.com/product/roles.md): who can do what.

**Support and customer success**

* [Features](https://docs.snapfix.com/product/features.md): one page per feature, with its rules and where the web, iOS and Android differ. Start here for "can Snapfix do this?" and "why does the customer see that?".
* [Screens](https://docs.snapfix.com/how-the-apps-work/screens.md): one page per screen, with what it shows, its inputs, its actions and its messages.
* [Navigation](https://docs.snapfix.com/how-the-apps-work/nav.md): where each screen sits and how to get there.

**Sales and marketing**

* [What Snapfix is](https://docs.snapfix.com/product/product.md) and [Features](https://docs.snapfix.com/product/features.md), with the platforms each feature runs on.
* [Subscriptions](https://docs.snapfix.com/product/features/billing/subscriptions.md): plans, what they allow, and how customers pay.

**Product and design**

* [Features](https://docs.snapfix.com/product/features.md) and [Screens](https://docs.snapfix.com/how-the-apps-work/screens.md): today's behavior, the starting point for any change.
* [Shared behavior](https://docs.snapfix.com/how-the-apps-work/shared.md): what many screens have in common, such as sign-in, switching sites, notifications and offline use.
* How things look is in Figma. Screen pages link to their Figma frame when it is known.

**Engineering**

* [Shared behavior](https://docs.snapfix.com/how-the-apps-work/shared.md), [Navigation](https://docs.snapfix.com/how-the-apps-work/nav.md) and [Screens](https://docs.snapfix.com/how-the-apps-work/screens.md) for the apps.
* [API](https://docs.snapfix.com/engineering-reference/api.md): the endpoints the apps call, one page per group.
* [Database](https://docs.snapfix.com/engineering-reference/db.md): the tables and what their data means.
* [Infrastructure](https://docs.snapfix.com/engineering-reference/infra.md): where Snapfix runs, its services and third parties, releases and monitoring.

## What is not here

* **Plans.** Pages describe the product as it works now, not features planned for later.
* **Known problems.** Engineering tracks bugs and security issues separately; this site leaves them out.
* **Customer help.** Help articles for customers are in the Snapfix help center.

Found a mistake or a missing page? Tell the Snapfix docs owners.


---

# 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/snapfix-docs.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.
