Control Plane Corporation Documentation

This repository contains the documentation for Control Plane Corporation.

👩‍💻 Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of your documentation (where mint.json is)

mintlify dev

mintlify broken-links

🔄 Syncing API Reference from OpenAPI Specs

To sync the API reference pages with the latest OpenAPI specifications, run:

npx @mintlify/scraping@latest openapi-file https://api.cpln.io/openapi.json -o api-reference
npx @mintlify/scraping@latest openapi-file https://audit.cpln.io/openapi.json -o api-reference/audit

🔄 Syncing CLI Reference from CLI Help

The cli-reference/commands/ pages and a few other CLI files are auto-generated by the docs-cli-generator sibling repository. To update them:

cd ../docs-cli-generator
npm run gen-full # or gen-quick if only updating checksums and download links
make publish

This replaces cli-reference/commands/, cli-reference/installation.mdx, cli-reference/using-cli/help.mdx, and cli-reference/ci-cd-development/container-image.mdx, then creates a PR. Do not manually edit these files.