# Fludly — Agent documentation index

> **For AI agents:** Fetch documents below via public GET (no authentication). Start with **userhelp.md** for product UI and workflow questions.

## Primary knowledge base

| Document                    | URL                 | Use when                                                                                             |
| --------------------------- | ------------------- | ---------------------------------------------------------------------------------------------------- |
| **Platform UI & workflows** | `/docs/userhelp.md` | User asks how Fludly works, where to click, publish, print, cart, waiter QR, admin panes, onboarding |
| **This index**              | `/docs/index.md`    | Discovering which doc to load                                                                        |

## Related API documentation (not in `/docs/`)

| Surface                 | URL                                            | Auth                             | Use when                                                                |
| ----------------------- | ---------------------------------------------- | -------------------------------- | ----------------------------------------------------------------------- |
| Per-restaurant menu API | `/api/{clientId}/agent?token=...`              | `?token=` from Admin → Home      | Live menu data, dishes, prices, images, branding for **one** restaurant |
| Per-restaurant OpenAPI  | `/api/{clientId}/agent/openapi.json?token=...` | same                             | Machine-readable menu API                                               |
| Provisioning API        | `/api/provision`                               | none (docs); Bearer key (writes) | Server automation: create clients, populate menus, publish              |
| Provisioning OpenAPI    | `/api/provision/openapi.json`                  | none                             | Machine-readable provisioning API                                       |

## Agent workflow

1. **How-to / product question** → fetch `/docs/userhelp.md` → answer in user's language.
2. **Specific restaurant menu content** → use `/api/{clientId}/agent?token=...` (token from that restaurant's admin).
3. **Automated onboarding** → fetch `/api/provision` first.

Do not read markdown files verbatim to end users.

## Adding documents

Place new `.md` files in `public/docs/`. They are served automatically at `/docs/{filename}`.