morgankrey
9168df6260
## Summary
Comprehensive remediation of 146 documentation files to align with Zed's
documentation conventions and brand voice guidelines.
## Changes
### YAML Frontmatter
- Added `title` and `description` frontmatter to all docs missing it
### Settings UI Pattern
- Updated 48+ files to show Settings Editor before JSON examples
- Pattern: `Configure X in Settings ({#kb zed::OpenSettings}), or add to
your settings file:`
- Added `([how to edit](./configuring-zed.md#settings-files))` links for
JSON-only settings
### Brand Voice Fixes
- Removed exclamation points (command-palette, key-bindings, repl,
privacy-and-security, etc.)
- Simplified em dash chains to parentheticals (environment,
troubleshooting, agent-panel, etc.)
- Fixed marketing language (yarn.md intro, development/linux.md)
### Terminology Alignment
- `settings UI` -> `Settings Editor`
- `sidebar` -> specific panel names (Project Panel, Collab Panel)
- `directory` -> `folder` in non-technical contexts
- `workspace` -> `project` in non-LSP contexts
- `Command Palette` -> `command palette` (lowercase)
### Callout Standardization
- Converted various callout formats to standard `> **Note:**` pattern
## Related
Depends on conventions established in #49176.
Release Notes:
- N/A
1.5 KiB
title, description
| title | description |
|---|---|
| OCaml | Configure OCaml language support in Zed, including language servers, formatting, and debugging. |
OCaml
OCaml support is available through the OCaml extension.
- Tree-sitter: tree-sitter/tree-sitter-ocaml
- Language Server: ocaml/ocaml-lsp
Setup Instructions
If you have the development environment already setup, you can skip to Launching Zed
Using Opam
Opam is the official package manager for OCaml and is highly recommended for getting started with OCaml. To get started using Opam, please follow the instructions provided here.
Once you install opam and setup a switch with your development environment as per the instructions, you can proceed.
Launching Zed
By now you should have ocamllsp installed, you can verify so by running
ocamllsp --help
in your terminal. If you get a help message, you're good to go. If not, please revisit the installation instructions for ocamllsp and ensure it's properly installed.
With that aside, we can now launch Zed. Given how the OCaml package manager works, we require you to run Zed from the terminal, so please make sure you install the Zed cli if you haven't already.
Once you have the cli, simply from a terminal, navigate to your project and run
zed .
You should now have Zed running with OCaml support, with no additional setup required.