📚 Ultralytics Handbook

Welcome to the Ultralytics Handbook repository! This repository houses the source files for the official Ultralytics Handbook - your comprehensive guide to our mission, vision, values, and operational practices. Built with Zensical (a modern static site generator by the creators of Material for MkDocs), the Handbook is continuously deployed via Vercel to handbook.ultralytics.com.

This Handbook serves as a living document, evolving alongside Ultralytics' growth. It aims to align team members, contributors, and the wider community with the core principles guiding our work in artificial intelligence (AI) and computer vision. Whether you're new to Ultralytics or a seasoned team member, this resource provides insights into everything from our company philosophy to detailed workflows and operational processes, including our approach to machine learning operations (MLOps).

New team members? Start with our Onboarding Guide for your first 90 days roadmap.

🧰 Technology Stack

• Zensical - Modern static site generator (by the creators of Material for MkDocs)
• MkDocs Ultralytics Plugin - Custom features and integrations
• Ultralytics Chat - Realtime conversational AI with open-source chat.js implementation
• Vercel - Hosting and deployment
• GitHub Actions - CI/CD automation

🛠️ Installation

To build and develop the Handbook locally, install dependencies:

pip install zensical mkdocs-ultralytics-plugin

This installs Zensical - a modern static site generator built by the creators of Material for MkDocs - and our custom plugin for enhanced documentation features.

🚀 Local Development

Build and serve the Handbook locally with live reload:

zensical serve

The site will be available at http://127.0.0.1:8000. Changes to source files trigger automatic rebuilds.

Development Commands

• zensical serve - Start development server with live reload
• zensical build - Build static site to site/ directory

📤 Deployment

The Handbook automatically deploys to handbook.ultralytics.com via Vercel when changes are pushed to the main branch.

💡 Contributing

We welcome contributions to the Ultralytics Handbook! Your input helps keep our documentation accurate, comprehensive, and useful.

How to Contribute

1. Fork the repository and create a feature branch
2. Make your changes to Markdown files in docs/en/
3. Test locally with zensical serve
4. Submit a pull request with clear description of changes
5. Follow our style guide (consistent with existing pages)

Contribution Guidelines

• Use clear, concise language aligned with the handbook's professional tone
• Follow the existing structure and formatting (120-character lines, emoji usage)
• Include proper frontmatter (description and keywords) on all pages
• Test all internal links and ensure proper navigation
• Use tables, admonitions, and formatting consistently with other pages

See our Contributing Guide for detailed information.

📂 Repository Structure

handbook/
├── docs/
│   ├── en/                          # English documentation
│   │   ├── index.md                 # Homepage
│   │   ├── introduction.md          # Handbook introduction
│   │   ├── mission-vision-values/   # Company foundation
│   │   ├── finance/                 # Financial policies
│   │   ├── tools/                   # Hardware & software
│   │   ├── people/                  # HR policies
│   │   ├── workflows/               # Development processes
│   │   ├── contributions/           # Community guidelines
│   │   ├── goals/                   # OKRs and company goals
│   │   ├── faq/                     # Common questions
│   │   ├── legal/                   # Legal & compliance
│   │   └── security/                # Security policies
│   └── overrides/                   # Theme customizations
├── .github/
│   └── workflows/                   # CI/CD automation
├── mkdocs.yml                       # MkDocs configuration
├── pyproject.toml                   # Python project config
├── requirements.txt                 # Python dependencies
└── README.md                        # This file

📄 License

Ultralytics offers two licensing options:

• AGPL-3.0 License: Ideal for students, researchers, and enthusiasts passionate about open collaboration. This OSI-approved open-source license promotes transparency and community involvement. See the LICENSE file for details.
• Enterprise License: For commercial applications, this license permits seamless integration of Ultralytics software into commercial products, bypassing AGPL-3.0 copyleft requirements. Inquire about an Ultralytics Enterprise License.

✉️ Contact

For bug reports and feature requests related to the Ultralytics Handbook, please visit GitHub Issues. For questions, discussions, and community support, join our active communities on Discord, Reddit, and the Ultralytics Community Forums. We're here to help with all things Ultralytics!