Dabar docs — agent instructions
About this project
- Public documentation site for the Dabar API, built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Run
mint devto preview locally - Run
mint broken-linksto check links
Terminology
- Politics — a reusable analysis policy. Stored in the
politicscollection. - Project — a run that applies a politics to a set of files. Stored in the
projectcollection. - User — an authenticated Dabar account (collection
user). Authentication uses theauth.tokenfield, sent by clients as theapi-tokenheader. - Knowledge files — reference documents attached to a politics (word / pdf). They must be publicly accessible URLs.
- Files — inputs attached to a project (video, document, url, photo, audio, text). Text files are uploaded to the
dabarai-assetsS3 bucket automatically.
Style preferences
- Use active voice and second person (“you”)
- Keep sentences concise — one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click Settings
- Code formatting for file names, commands, paths, and code references
- Document request/response examples with
<RequestExample>/<ResponseExample>blocks - Document parameters with
<ParamField>and responses with<ResponseField>
Content boundaries
- Document only the public lambda endpoints (Projects, Politics)
- Do not expose internal collection structure beyond what the API returns
- Do not include credentials, tokens, VPC IDs, or role ARNs in public pages