README.md

---
title: README
emoji: 🌖
colorFrom: blue
colorTo: green
sdk: static
pinned: false
---

# HuggingFace Doc Builds

This organization contains doc build artifacts for Hugging Face open source libraries that get displayed at [hf.co/docs](hf.co/docs).

## How does it work?

### When a PR gets merged to main

See example github action run [here](https://github.com/huggingface/transformers/actions/runs/6545293440/job/17773457744).

1. [huggingface/doc-builder](https://github.com/huggingface/doc-builder) builds and pushes doc artifacts to [hf-doc-build/doc-build](https://huggingface.co/datasets/hf-doc-build/doc-build).
2. [hf.co/docs](hf.co/docs) pulls updates from [hf-doc-build/doc-build](https://huggingface.co/datasets/hf-doc-build/doc-build).

### When a new PR is opened

See example [here](https://github.com/huggingface/datasets/pull/6269#issuecomment-1741178779).

1. [huggingface/doc-builder](https://github.com/huggingface/doc-builder) builds and pushes doc artifacts to [hf-doc-build/doc-build-dev](https://huggingface.co/datasets/hf-doc-build/doc-build-dev).
2. [moon-ci-docs.huggingface.co/docs](https://moon-ci-docs.huggingface.co/docs) pulls updates from [hf-doc-build/doc-build-dev](https://huggingface.co/datasets/hf-doc-build/doc-build-dev).