zed/docs
Bosco 7fd736e23c
docs: Update macOS development docs with dispatch.h error solution (#11986)
### Title
Update macOS Development Documentation with Dispatch.h Error Solution

### Description
This PR updates the macOS development documentation to include a
solution for the `dispatch/dispatch.h` file not found error. This error
is encountered during local development when using the `cargo run`
command. The documentation now includes steps to ensure the Xcode
command line tools are properly installed and set, and instructions to
set the `BINDGEN_EXTRA_CLANG_ARGS` environment variable.

### Changes
- Added troubleshooting section for `dispatch/dispatch.h` error in
`development/macos.md`.

### Related Issues
- Closes [#11963](https://github.com/zed-industries/zed/issues/11963)

### Testing Instructions
1. Follow the steps in the updated `development/macos.md` to configure
your environment.
2. Run `cargo clean` and `cargo run` to ensure the build completes
successfully.

Release Notes:

- N/A
2024-05-17 14:10:57 -04:00
..
src docs: Update macOS development docs with dispatch.h error solution (#11986) 2024-05-17 14:10:57 -04:00
theme docs: Fix copying code blocks (#11617) 2024-05-09 11:52:26 -04:00
.gitignore
book.toml
README.md docs: Update README (#11442) 2024-05-06 11:33:48 -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-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.