Skip to main content

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 dev to preview locally
  • Run mint broken-links to check links

Terminology

  • Politics — a reusable analysis policy. Stored in the politics collection.
  • Project — a run that applies a politics to a set of files. Stored in the project collection.
  • User — an authenticated Dabar account (collection user). Authentication uses the auth.token field, sent by clients as the api-token header.
  • 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-assets S3 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