{"id":19454119,"url":"https://github.com/ultralytics/handbook","last_synced_at":"2025-06-19T22:10:14.411Z","repository":{"id":257912993,"uuid":"872096079","full_name":"ultralytics/handbook","owner":"ultralytics","description":"A guide to Ultralytics' mission, vision, values, and practices, providing key insights and resources for aligning with our goals.","archived":false,"fork":false,"pushed_at":"2025-06-12T14:06:01.000Z","size":1961,"stargazers_count":17,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-12T15:23:36.105Z","etag":null,"topics":["ai","culture","employees","goals","handbook","mission","practices","ultralytics","values","vision","yolo"],"latest_commit_sha":null,"homepage":"https://handbook.ultralytics.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ultralytics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"glenn-jocher","patreon":"ultralytics","open_collective":"ultralytics"}},"created_at":"2024-10-13T19:08:57.000Z","updated_at":"2025-06-12T14:05:34.000Z","dependencies_parsed_at":"2024-10-23T16:07:31.245Z","dependency_job_id":"1d69b1bc-6dba-46d3-b063-b57ac05bd0a9","html_url":"https://github.com/ultralytics/handbook","commit_stats":null,"previous_names":["ultralytics/handbook"],"tags_count":1,"template":false,"template_full_name":"ultralytics/template","purl":"pkg:github/ultralytics/handbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fhandbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fhandbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fhandbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fhandbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ultralytics","download_url":"https://codeload.github.com/ultralytics/handbook/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fhandbook/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260838658,"owners_count":23070612,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","culture","employees","goals","handbook","mission","practices","ultralytics","values","vision","yolo"],"created_at":"2024-11-10T17:08:01.075Z","updated_at":"2025-06-19T22:10:09.370Z","avatar_url":"https://github.com/ultralytics.png","language":null,"funding_links":["https://github.com/sponsors/glenn-jocher","https://patreon.com/ultralytics","https://opencollective.com/ultralytics"],"categories":[],"sub_categories":[],"readme":"\u003cbr\u003e\n\u003ca href=\"https://www.ultralytics.com/\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg\" width=\"320\" alt=\"Ultralytics logo\"\u003e\u003c/a\u003e\n\n# 📚 Ultralytics Handbook\n\nWelcome to the **Ultralytics Handbook repository**, the source for all the content that forms the official [Ultralytics Handbook](https://handbook.ultralytics.com/). This repository contains Markdown files that outline our **mission, vision, values, and internal practices**, and is designed to provide clarity on how Ultralytics operates. The Handbook is built using **MkDocs Material** and is continuously updated to reflect the latest company guidelines. It is deployed via GitHub Pages to [https://handbook.ultralytics.com](https://handbook.ultralytics.com/).\n\n[![pages-build-deployment](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/pages/pages-build-deployment)\n[![Check Broken links](https://github.com/ultralytics/handbook/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/links.yml)\n[![Ultralytics Actions](https://github.com/ultralytics/handbook/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/handbook/actions/workflows/format.yml)\n\n\u003ca href=\"https://discord.com/invite/ultralytics\"\u003e\u003cimg alt=\"Discord\" src=\"https://img.shields.io/discord/1089800235347353640?logo=discord\u0026logoColor=white\u0026label=Discord\u0026color=blue\"\u003e\u003c/a\u003e \u003ca href=\"https://community.ultralytics.com/\"\u003e\u003cimg alt=\"Ultralytics Forums\" src=\"https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com\u0026logo=discourse\u0026label=Forums\u0026color=blue\"\u003e\u003c/a\u003e \u003ca href=\"https://reddit.com/r/ultralytics\"\u003e\u003cimg alt=\"Ultralytics Reddit\" src=\"https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat\u0026logo=reddit\u0026logoColor=white\u0026label=Reddit\u0026color=blue\"\u003e\u003c/a\u003e\n\nThis Handbook serves as a **living document**—evolving as Ultralytics grows—and is intended to align team members, contributors, and the community with the principles that drive our work. Whether you're new to Ultralytics or a long-standing team member, this Handbook is here to guide you through everything from company philosophy to detailed workflows and processes.\n\n## 🛠️ Installation\n\n[![PyPI - Version](https://img.shields.io/pypi/v/ultralytics?logo=pypi\u0026logoColor=white)](https://pypi.org/project/ultralytics/)\n[![Downloads](https://static.pepy.tech/badge/ultralytics)](https://www.pepy.tech/projects/ultralytics)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ultralytics?logo=python\u0026logoColor=gold)](https://pypi.org/project/ultralytics/)\n\nTo install MkDocs and all the dependencies required to build and develop the Handbook site, simply run:\n\n```bash\npip install black mkdocs-material mkdocs-ultralytics-plugin\n```\n\nThis command sets up MkDocs and its required plugins, enabling local development and testing of the Handbook documentation.\n\n## 🚀 Building and Serving Locally\n\nUse the following command to build and serve a local instance of the Handbook:\n\n```bash\nmkdocs serve\n```\n\nThis will start a local server with live reloading, allowing you to see updates as you modify the content.\n\n### Key Details:\n\n- **`mkdocs`**: The primary command-line interface for MkDocs.\n- **`serve`**: Builds the site and serves it locally with live reload.\n\nTo stop the server, simply press `CTRL+C`.\n\n## 📤 Deploying Your Documentation Site\n\nTo deploy the Handbook to GitHub Pages or any other hosting platform:\n\n1. Configure your `mkdocs.yml` with deployment settings.\n2. Run the following command to deploy:\n\n```bash\nmkdocs gh-deploy\n```\n\nFor a custom domain, update the \"Custom domain\" settings in your GitHub repository to use [handbook.ultralytics.com](https://handbook.ultralytics.com/).\n\n![Deployment Example](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png)\n\nFor further instructions, refer to the [MkDocs deployment guide](https://www.mkdocs.org/user-guide/deploying-your-docs/).\n\n## 💡 Contributing\n\nWe welcome contributions to the Ultralytics Handbook! Whether you're helping improve documentation or proposing new ideas, your input is valuable. For more details on how to contribute, please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/).\n\n![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)\n\n## 📜 License\n\nThe Ultralytics Handbook is available under the following licenses:\n\n- **AGPL-3.0 License**: Designed for academic and open-source projects. Refer to the [LICENSE](https://github.com/ultralytics/handbook/blob/main/LICENSE) file for specifics.\n- **Enterprise License**: Suitable for commercial applications of Ultralytics technologies. Visit [Ultralytics Licensing](https://www.ultralytics.com/license) for more information.\n\n## ✉️ Contact\n\nFor any issues, bug reports, or feature requests, please use [GitHub Issues](https://github.com/ultralytics/handbook/issues). You can also join the conversation on [Discord](https://discord.com/invite/ultralytics) to engage with the Ultralytics community and team.\n\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png\" width=\"3%\" alt=\"Ultralytics GitHub\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://www.linkedin.com/company/ultralytics/\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png\" width=\"3%\" alt=\"Ultralytics LinkedIn\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://twitter.com/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png\" width=\"3%\" alt=\"Ultralytics Twitter\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://youtube.com/ultralytics?sub_confirmation=1\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png\" width=\"3%\" alt=\"Ultralytics YouTube\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://www.tiktok.com/@ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png\" width=\"3%\" alt=\"Ultralytics TikTok\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://ultralytics.com/bilibili\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png\" width=\"3%\" alt=\"Ultralytics BiliBili\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://discord.com/invite/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png\" width=\"3%\" alt=\"Ultralytics Discord\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultralytics%2Fhandbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fultralytics%2Fhandbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultralytics%2Fhandbook/lists"}