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.- Run in dev mode:
mintlify dev - Build for production:
mintlify build - Deploy to production:
mintlify deploy
Code Style and Conventions
- Framework: Docs are built with Mintlify. See 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.
- Images are stored in
- Customization:
- Custom styles are in
styles.css. - The color scheme and theme are defined in
docs.json.
- Custom styles are in
- 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): ...).