mirror of
https://github.com/zed-industries/zed.git
synced 2025-01-29 05:33:49 +00:00
583b6235fb
This also rolls back the `TerminalWorkDir` abstraction I added for the original remoting, and tidies up the terminal creation code to be clear about whether we're creating a task *or* a terminal. The previous logic was a little muddy because it assumed we could be doing both at the same time (which was not true). Release Notes: - remoting alpha: Removed the ability to specify `gh cs ssh` or `gcloud compute ssh` etc. See https://zed.dev/docs/remote-development for alternatives. - remoting alpha: Added support for terminal and tasks to new experimental ssh remoting |
||
---|---|---|
.. | ||
src | ||
theme | ||
.gitignore | ||
.prettierignore | ||
book.toml | ||
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-proxy
that intercepts requests tozed.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 tomain
.
Table of Contents
The table of contents files (theme/page-toc.js
and theme/page-doc.css
) were initially generated by mdbook-pagetoc
.
Since all these preprocessor does is generate the static assets, we don't need to keep it around once they have been generated.