README.md

 1# Zed Docs
 2
 3Welcome to Zed's documentation.
 4
 5This is built on push to `main` and published automatically to [https://zed.dev/docs](https://zed.dev/docs).
 6
 7To preview the docs locally you will need to install [mdBook](https://rust-lang.github.io/mdBook/), and then run:
 8
 9```
10mdbook serve docs
11```
12
13## Images and videos
14
15To add images or videos to the docs, upload them to another location (e.g., zed.dev, GitHub's asset storage) and then link out to them from the docs.
16
17Putting binary assets such as images in the Git repository will bloat the repository size over time.
18
19## Internal notes:
20
21- We have a Cloudflare router called `docs-proxy`that intercepts requests to `zed.dev/docs` and forwards them to the "docs" Cloudflare Pages project.
22- CI uploads a new version to the Pages project from `.github/workflows/deploy_docs.yml` on every push to `main`.