Skip to content

Repository files navigation

DoorOps Docs

Public product, API, MCP, and integration documentation for DoorOps.

This is a Mintlify site in its own repo. Engineering specs, SITREP, and internal plans stay in the DoorOps app repo under docs/. Do not copy those here.

Where it lives

SurfaceURLWho it is for
This sitehttps://docs.doorops.comCustomers, integrators, AI agents
Marketing developer hubhttps://doorops.com/developersProspects and a short path into these docs
Live OpenAPI UIhttps://doorops.com/docs/apiSigned-in try-it against your tenant (Scramble)
Tenant MCPhttps://{org}.doorops.com/mcpAuthenticated agents
Public marketing MCPhttps://doorops.com/mcpProduct facts and enquiries, no login

docs.doorops.com is the right home. Stripe, Twilio, Linear and GitHub all use docs.. Putting the full library on doorops.com/docs would fight Laravel Cloud (the app already uses /docs/api) and tenant wildcards.

Do not fold this into the DoorOps Laravel app. Docs would then ship on the same deploy as production jobs, and a docs typo would wait behind a PHP build.

Hosting

  1. Connect this GitHub repo in the Mintlify dashboard.
  2. Custom domain: docs.doorops.com.
  3. DNS: CNAME docs to the Mintlify host (not to.laravel.cloud).
  4. Keep docs in DoorOps reserved subdomains so a tenant cannot claim it.

Cloudflare is the DNS/CDN layer in front of that CNAME. It is not a second docs app.

Preview locally

npm i -g mint
mint dev

Open http://localhost:3000.

Refresh the OpenAPI snapshot

From the DoorOps app repo:

php artisan scramble:export --path=/path/to/docs/api-reference/openapi.json

Then set servers to https://{tenant}.doorops.com/api/v1 before committing. The interactive playground on doorops.com/docs/api is generated live from the app and stays the source of truth for "try it".

What is public vs internal

Public (this repo): how to use DoorOps, every customer-facing feature, REST API, MCP, CLI, webhooks, native connectors, and how to build your own integration when we do not have one.

Internal (app repo docs/): SITREP, ADRs, compliance drafts, staff platform runbooks, unreleased plans. Never publish those on docs.doorops.com.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

Generated from mintlify/starter