Skip to content

docs: Mintlify documentation site + API reference - #2

Open
Goldokpa wants to merge 1 commit into
mainfrom
docs/mintlify-site
Open

docs: Mintlify documentation site + API reference#2
Goldokpa wants to merge 1 commit into
mainfrom
docs/mintlify-site

Conversation

@Goldokpa

Copy link
Copy Markdown
Collaborator

Adds a deployable Mintlify docs site under `docs-site/` — guides + a live API reference.

What's in it

  • Guides: introduction, quickstart, core concepts, authentication & scopes, Python & TypeScript SDKs, production flow, MCP gateway/HITL, ACS Guardian, limits & errors, security.
  • API Reference: auto-generated from the control plane's own OpenAPI schema (95 endpoints, 26 tags). Post-processed to add the production server URL (`https://api.identark.io\`) and a `csk_` bearer-auth scheme so the playground shows the Authorization field.
  • Brand assets (logo light/dark, favicon), config (`docs.json`), and a `README.md` with run + spec-regeneration steps.

Verified locally with `mint dev` — both tabs, nav, theming, and the generated endpoint pages (method chip, Try-it, bearer auth, typed params, response examples) render.

To host at docs.identark.io

  1. Connect `identark/identark` in the Mintlify dashboard; set content directory to `docs-site/` and the deploy branch to `main`.
  2. Add the custom domain `docs.identark.io` in Mintlify → it gives a CNAME target.
  3. Add that CNAME in Cloudflare (the `infrastructure/modules/dns` module).

Keeping the reference in sync

`docs-site/README.md` has a one-shot script to regenerate `api-reference/openapi.json` from the FastAPI app whenever the API changes.

🤖 Generated with Claude Code

Adds a deployable Mintlify docs project under docs-site/:
- Guides: introduction, quickstart, concepts, authentication, SDKs
  (Python/TS), production flow, MCP/HITL, ACS Guardian, limits & errors,
  security.
- API Reference auto-generated from the control plane's own OpenAPI
  schema (95 endpoints), post-processed with the production server URL
  and a csk_ bearer-auth scheme.
- Verified rendering with the Mintlify CLI (mint dev).

Host by connecting the repo in the Mintlify dashboard with content
directory docs-site/, custom domain docs.identark.io.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants