## 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.4 KiB
1.4 KiB
title, description
| title | description |
|---|---|
| Elm | Configure Elm language support in Zed, including language servers, formatting, and debugging. |
Elm
Elm support is available through the Elm extension.
- Tree-sitter: elm-tooling/tree-sitter-elm
- Language Server: elm-tooling/elm-language-server
Setup
Zed support for Elm requires installation of elm, elm-format, and elm-review.
- Install Elm (or run
brew install elmon macOS). - Install
elm-reviewto support code linting:npm install elm-review --save-dev - Install
elm-formatto support automatic formattingnpm install -g elm-format
Configuring elm-language-server
Elm language server can be configured in your settings.json, e.g.:
{
"lsp": {
"elm-language-server": {
"initialization_options": {
"disableElmLSDiagnostics": true,
"onlyUpdateDiagnosticsOnSave": false,
"elmReviewDiagnostics": "warning"
}
}
}
}
elm-format, elm-review and elm need to be installed and made available in the environment or configured in the settings. See the full list of server settings here.