> 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-to-read.md).

# How to read these docs

These pages describe what Snapfix does today. AI agents write them from Snapfix's code, its staging database and the live app, and update this site after every change. This page explains the marks you see on them.

## The box under each title

* **"Draft, written by an agent and not yet checked by a person"**: an agent wrote the page and checked it against the code and the app, but no person has reviewed it. Drafts are mostly right and sometimes wrong. Before you promise something to a customer or build on a detail, confirm it with the team.
* **"Checked by a person"**: someone who knows the area read the page and confirmed it.
* **"Placeholder, not written yet"**: the page holds a place for content that is still to come.
* **"Generated from the staging database schema, with descriptions drafted by agents"**: a database table page. Its columns come straight from the database; the descriptions are drafts.
* **"Platforms"**: where a screen exists: the web, iOS, Android, or several of them. Feature pages have a "Platforms" section instead.
* **"Source on GitHub"**: the same page in the docs repo, with its history. It opens only for people with access to the `snapfix/docs` repo on GitHub.

## Open questions

A link like \[ASK-12] after a statement means the agent could not settle it from the code and the app, and asked the team. The statement is the agent's best answer from the evidence: treat it as unconfirmed until the question is answered. The link opens the question in the docs repo, which needs GitHub access.

## Words in quotes and in code font

* Words in quotes are exactly what the app shows, such as "Add task".
* Words in `code font` are names in the code or the database, such as `tPri_Job`. They help engineers find the code; everyone else can skip them.
* The [Glossary](https://docs.snapfix.com/product/glossary.md) maps the words on the screen to the names in the code.

## How the site is organized

* **Product**: what Snapfix is, the glossary, roles, and one page per feature, grouped by area. Start here if you are not an engineer.
* **How the apps work**: navigation, behavior that many screens share, and one page per screen with its inputs, actions and messages.
* **Engineering reference**: the API, the database and the infrastructure. Each area has a tables page that leads to its database tables.

A feature page starts with what the feature does, then its "Rules" and "Flow", then "Platforms": where the web, iOS and Android differ. "Screens", "API and data" and "Depends on" lead to the screen pages and the engineering details. "Edge cases" lists unusual situations and what happens in them.

## What the pages leave out

* **Plans.** Pages describe the product as it works now, not features planned for later.
* **Design.** Figma is the source of truth for how things look. Screen pages link to their Figma frame when it is known.
* **Known problems.** Pages describe what the app does, including behavior that is a bug, but the list of known problems stays with engineering. When a behavior looks wrong, ask the team before you call it intended.

## Changes and corrections

* Pages change often. Each page's "Source on GitHub" link shows what changed and when.
* Do not edit pages in GitBook: the next update overwrites the edit. Report a mistake or a missing page to the Snapfix docs owners instead.
* Engineers: the pages are `product/` and `spec/` of the `snapfix/docs` repo. Its `scripts/gitbook.py publish` copies them into `snapfix/gitbook`, which GitBook syncs. Change pages in `snapfix/docs`. In `snapfix/gitbook`, only this page, the home page and `.gitbook.yaml` are edited by hand, by pull request.


---

# 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-to-read.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.
