mirror of
https://github.com/zed-industries/zed.git
synced 2025-01-01 05:44:17 +00:00
f9b0792aa0
Release Notes: - N/A --- I'd like to help improve Configuration documentation. Currently I'm often confused by the configuration doc. It's incomplete: not all settings are documented. It's disorganized: some options are grouped together but overall there's not much structure or logic to it. It's inconsistent: some examples show only key and value, some—just the closes object, and others full nesting. It's confusing: individual keys are listed but it's hard to understand where in the config structure they belong. I suggest the following changes: - Always specify the full path of the setting - Document all settings Zed recognises - List settings in alphabetical order of their full path - Always use full nesting in examples This is an example, of what it might look like. It's first draft, too. So I'm open to suggestions. Please let me know if you're interested in this. The whole thing might need a bit of effort so I'd like to know if this is something you might want before doing all the work. --------- Co-authored-by: Conrad Irwin <conrad.irwin@gmail.com> |
||
|---|---|---|
| .. | ||
| src | ||
| theme | ||
| .gitignore | ||
| 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.