zed-industries/zed
1
1
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2024-11-08 07:35:01 +03:00
Code Issues Packages Projects Releases Wiki Activity
2e23527e09
zed/docs
History
YeonGyu-Kim a334c69e05
Add instructions for configuring linting in the Python documentation using Ruff extension (#14896) 
Added documentation for #14198

I also suggest replacing format guides from `black` to `ruff` to unify
the tooling in the document.

Ruff is now widely used in the Python community, including
[fastapi](cd6e9db065/pyproject.toml (L213)).
It's compatible with black but a lot faster.

Release Notes:

- N/A
2024-07-22 11:59:42 +02:00
..
src Add instructions for configuring linting in the Python documentation using Ruff extension (#14896) 2024-07-22 11:59:42 +02:00
theme Fix video rendering on docs (#14764) 2024-07-18 13:34:25 -06:00
.gitignore Setup docs deployments with mdBook (#11369) 2024-05-03 15:52:15 -04:00
book.toml docs: Change path from /docs2 to /docs (#11436) 2024-05-06 10:51:37 -04:00
README.md docs: Update README (#11442) 2024-05-06 11:33:48 -04:00

README.md

Zed Docs

Welcome to Zed's documentation.

This is built on push to main and published automatically to https://zed.dev/docs.

To preview the docs locally you will need to install mdBook, and then run:

mdbook serve 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-proxythat 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.