Kubiya Public Docs

This repository contains the public documentation for Kubiya, built with Mintlify.

Overview

The docs site includes:

• Introduction and core concepts
• Quickstart guides
• API references (placeholders where noted)
• SDK and Terraform sections (placeholders where noted)

Content is authored in MDX and configured via docs.json. Custom styling lives in style.css.

Prerequisites

• Node.js LTS installed
• Mintlify CLI installed globally

Install the Mintlify CLI if you do not have it:

npm install -g mintlify

Run the docs locally

From the repository root, run:

mintlify dev

This starts the local development server. Open the printed URL in your browser. The server reloads on changes to MDX, JSON, or CSS files.

Build and preview

To build a production version and preview it locally:

mintlify build
mintlify preview

Configuration

• Site configuration: docs.json
• Custom styles: style.css
• Assets such as images: assets/

Notes:

• Some legacy keys in docs.json may not be supported by newer Mintlify schemas. Validate config changes with the CLI output.
• The logo is configured for light/dark variants via the logo field in docs.json.

Content guidelines

• Use clear, concise headings and short paragraphs.
• Prefer task-based guides and examples where possible.
• Keep headings unbolded; reserve bold for emphasis in body text only.

Contributing

1. Create a new branch for your change.
2. Edit or add MDX files under the relevant section.
3. Update docs.json only with supported keys. Validate with mintlify dev.
4. Run locally and verify formatting, links, and images.
5. Open a pull request with a clear description of changes.

Troubleshooting

• If the site fails to start, check the Mintlify CLI version and schema compatibility.
• If styles appear inconsistent between light and dark modes, verify variables in style.css and avoid translucent backgrounds for interactive elements.

License

This documentation is maintained by Kubiya. Licensing terms follow those of the repository unless otherwise noted.