mirror of
https://github.com/zed-industries/zed.git
synced 2024-09-20 02:47:34 +03:00
55fc1f0afb
- The secrets portal is only used if the application is sandboxed without access to the org.freedesktop.secrets on the host but as zed is not really working correctly if sandboxed as is, it is better to completely omit that part - The org.freedestkop.secrets is not a portal but a spec file that is implemented by both gnome in gnome-keyring, kde in kwallet but also by other password managers like keepassxc and it is a requirement for a "correctly" set up linux desktop so just remove that wrongly documented bit Release Notes: - N/A |
||
|---|---|---|
| .. | ||
| 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-proxythat intercepts requests tozed.dev/docsand forwards them to the "docs" Cloudflare Pages project. - CI uploads a new version to the Pages project from
.github/workflows/deploy_docs.ymlon 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.