mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2025-02-03 17:44:30 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: Update README (#11442)

Browse source 
This PR updates the docs README with some notes about how to deal with
images.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-05-06 11:33:48 -04:00 committed by GitHub
parent 237cc9b4a9
commit 910963e5f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/README.md
View file

@ -1,3 +1,5 @@
# Zed Docs
Welcome to Zed's documentation.
This is built on push to `main` and published automatically to [https://zed.dev/docs](https://zed.dev/docs).
@ -8,7 +10,13 @@ To preview the docs locally you will need to install [mdBook](https://rust-lang.
mdbook serve docs
```
### Internal docs:
## Images and videos
To 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.
Putting binary assets such as images in the Git repository will bloat the repository size over time.
## Internal notes:
- We have a Cloudflare router called `docs-proxy`that intercepts requests to `zed.dev/docs` and forwards them to the "docs" Cloudflare Pages project.
- CI uploads a new version to the Pages project from `.github/workflows/deploy_docs.yml` on every push to `main`.