Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.acornops.dev/llms.txt

Use this file to discover all available pages before exploring further.

This docs project is the public AcornOps documentation site. Keep it aligned with the deployment repository and the component contract docs when behavior changes.

​
Preview locally

Mintlify requires Node.js v20.17.0 or newer. Install the CLI: 
npm i -g mint
Run the preview from this directory: 
npm run dev
The local preview is available at http://localhost:3000. The production site is https://docs.acornops.dev/. Use that host for public documentation links; reserve /docs paths for local repository files or service-local Swagger UI routes.

​
Validate before pushing

Run the local structural checks: 
npm run check
When the Mintlify CLI is installed, also run: 
mint validate
mint broken-links
The local checker verifies that navigation pages exist, referenced assets exist, and stale template or legacy terms are not present.

​
Project map

Use these repositories as source material when updating public docs:
AreaSource to check
Platform deploymentacornops-deployment
Management console behaviormanagement-console-playground
Control-plane API and authcontrol-plane-playground/docs/contracts
Execution run lifecycleexecution-engine-playground/docs/contracts
LLM gateway and MCP behaviorllm-gateway-playground/docs/contracts
Workload-cluster agentk8s-agent-playground
Prefer summarizing stable public behavior here. Keep detailed implementation notes in the component repositories.

​
Local platform development

The deployment repository owns the full local stack: 
task install
task doctor
task local-up
task local-ps
Common profiles include Dex or Keycloak OIDC and optional Vault-backed secret storage. Use task local-down to stop the stack and task local-reset when you need a clean local state. The management console can also run directly against a local control plane by setting its control-plane base URL and starting its dev server. Use this path for UI work when the full local stack is already available.

​
Contract and docs drift

Update public docs in the same change when you alter:
  • production hostnames or route layout,
  • deployment commands or required secrets,
  • OIDC callback behavior,
  • workspace roles or permissions,
  • public control-plane API shape,
  • workload-cluster agent install behavior,
  • run event stream behavior,
  • LLM provider, model, tool, or MCP policy behavior.
For API details, update the component contract docs first, then summarize the public behavior in API and auth.