zed/docs
Bilal Elmoussaoui 55fc1f0afb
docs: Remove wrongly documented secrets portals (#15303)
- 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
2024-08-01 17:07:26 -04:00
..
src docs: Remove wrongly documented secrets portals (#15303) 2024-08-01 17:07:26 -04:00
theme docs: Check formatting in CI (#15355) 2024-07-27 15:47:48 -04:00
.gitignore Setup docs deployments with mdBook (#11369) 2024-05-03 15:52:15 -04:00
.prettierignore docs: Check formatting in CI (#15355) 2024-07-27 15:47:48 -04:00
book.toml docs: Add table of contents navigation (#15212) 2024-07-27 10:34:14 -04:00
README.md docs: Add table of contents navigation (#15212) 2024-07-27 10:34:14 -04:00

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 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.

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.