Skip to main content
For Mintlify product knowledge (components, configuration, writing standards), install the Mintlify skill: npx skills add https://mintlify.com/docs

​
Documentation project instructions

​
About this project

  • This is the Flowra documentation site, built on Mintlify.
  • Audiences:
    • Product — dashboard and chat users (how the system works, where to click, short try-this paths)
    • Developers — API integrators (SDK, concepts, how-to guides, recipes, native tools)
    • API reference — OpenAPI-generated endpoints
  • Content is based on the product (dashboard + knowledge base), api-reference/openapi.json, official SDKs (@flowra/sdk, flowra-sdk / import flowra, @flowra/cli in github.com/flowradev/sdk), and verified API behavior.
  • SDK intro/tutorials: guides/sdk, guides/sdk-typescript, guides/sdk-python. Do not hand-edit generated OpenAPI. Do not hand-edit sdk/typescript/src/generated in the SDK repo.
  • Pages are MDX with YAML frontmatter; navigation is in docs.json.
  • Run mint dev to preview locally; run mint broken-links and mint validate before merge.

​
Terminology

  • Project — Your Flowra workspace: API-key boundary, shared setup (auth configs, tools, MCP), and container for external users. Nested scope map: Projects and API keys.
  • Workflow / agent — see Workflows and agents; prefer linking there instead of redefining
  • External user — end user of the customer’s product inside a project (x-username)
  • Connected account — one user’s OAuth link to a toolkit
  • Bold for UI labels: Click Settings

​
Style preferences

  • Use active voice and second person (“you”)
  • Keep sentences concise — one idea per sentence
  • Use sentence case for headings
  • No marketing filler (“powerful”, “seamless”, “robust”)
  • Product pages: no curl except under a clear “Developers” link
  • Screenshots are not required; add only for a few high-friction UI paths if needed later

​
Content boundaries

  • Do document: Product journeys, integrator guides, public OpenAPI surfaces (including Skills, Sandbox, Browser, Chat)
  • Do not document: Admin-only surfaces (statistics, outbound proxies, payment gateway admin, blog CMS), internal topology, secrets, or abuse-prone internals
  • Prefer updating an existing page over duplicating definitions across Product and Developers