> ## Documentation Index
> Fetch the complete documentation index at: https://gotrebol.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CRUSH

# Trébol Docs CRUSH

This document provides a summary of commands and guidelines for developing the Trébol documentation.

## Development Commands

This project uses Mintlify for documentation. The CLI is published as `mint` on npm (the older `mintlify` package is deprecated; its MDX parser flags valid Mintlify syntax like `{#custom-id}` heading anchors as errors).

* **Install / upgrade**: `npm i -g mint` (or `mint update`)
* **Run in dev mode**: `mint dev`
* **Build for production**: `mint build`
* **Deploy to production**: `mint deploy`

If you still have the old binary installed: `npm uninstall -g mintlify && npm cache clean --force && npm i -g mint`.

## Code Style and Conventions

* **Framework**: Docs are built with Mintlify. See [mintlify.com/docs](https://mintlify.com/docs) for more info.
* **Structure**: The documentation structure is defined in `docs.json`.
* **Content**:
  * All documentation is written in MDX.
  * API documentation is generated from `api-reference/openapi.yaml`.
* **Assets**:
  * Images are stored in `/images`.
  * Logos are in `/logo`.
* **Customization**:
  * Custom styles are in `styles.css`.
  * The color scheme and theme are defined in `docs.json`.
* **File Naming**: Use lowercase and hyphens for file names (e.g., `mi-nuevo-doc.mdx`).
* **Commits**:
  * Use conventional commit messages.
  * Reference the ticket number in your commits (e.g., `feat(TICKET-123): ...`).

## Style guide y revisión automática

* **Style guide**: see [`STYLE_GUIDE.md`](./STYLE_GUIDE.md) for tone, naming conventions, Mintlify component usage and DRY rules. All PRs are evaluated against this document.
* **Automated review on PRs**: every PR that touches `.mdx`, `.md`, `api-reference/openapi.yaml` or `docs.json` triggers the workflow at `.github/workflows/docs-review.yml`. It runs the multi-perspective review skills in `.claude/skills/` and posts a consolidated comment. The review never blocks merge — it suggests improvements.
* **Run reviews locally**: from this directory, run `claude` and invoke `/docs-orchestrator` to review uncommitted changes before opening the PR.