# AGENTS.md

Guidance for AI coding agents reading the Nosmai documentation site. This
file describes structure and navigation only, not product behavior. For
what the SDKs do, read the pages themselves.

## What the docs cover

Two product documentation sets:

- Nosmai Effects: real-time camera filters, beauty, makeup, AR face
  effects, backgrounds, capture and live streaming. Production mobile SDKs
  cover iOS and Android directly and through Flutter and React Native; Web is
  an authorized developer preview.
- Nosmai Moderation: on-device image, video, text and live-camera
  content moderation.

## URL grammar

- Docs pages live at `/docs/<product>/<page>/`.
- `<product>` is one of `effects` or `moderations`.
- Some pages are forked per platform. A forked page adds a trailing
  platform segment: `/docs/<product>/<page>/<platform>/`, where
  `<platform>` is one of `ios`, `android`, `web`, `react-native`,
  `flutter`.

## Raw-Markdown mirror

Every docs page has a raw-Markdown mirror at its own URL plus a `.md`
suffix (for example, `/docs/effects/introduction.md`). The mirror is
plain Markdown with no page chrome, so prefer it when fetching content
programmatically. The HTML page at the same path without `.md` is the
canonical human version.

## Machine indexes

- `/llms.txt`: top-level index pointing at the per-product bundles.
- `/llms/effects.txt`: every Effects page, linked to its `.md` mirror.
- `/llms/moderations.txt`: every Moderation page, linked to its `.md`
  mirror.
- `/llms-full.txt`: generated full-text corpus for both products. Prefer the
  scoped Effects index when the task only concerns Nosmai Effects.