morgankrey
6daa541e77
## 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.6 KiB
1.6 KiB
title, description
| title | description |
|---|---|
| Rego | Configure Rego language support in Zed, including language servers, formatting, and debugging. |
Rego
Rego language support in Zed is provided by the community-maintained Rego extension.
- Tree-sitter: FallenAngel97/tree-sitter-rego
- Language Server: open-policy-agent/regal
Installation
The extension is largely based on the Regal language server which should be installed to make use of the extension. Read the getting started instructions for more information.
Configuration
The extension's behavior is configured in the .regal/config.yaml file. The following is an example configuration which disables the todo-comment rule, customizes the line-length rule, and ignores test files for the opa-fmt rule:
rules:
style:
todo-comment:
# don't report on todo comments
level: ignore
line-length:
# custom rule configuration
max-line-length: 100
# warn on too long lines, but don't fail
level: warning
opa-fmt:
# not needed as error is the default, but
# being explicit won't hurt
level: error
# files can be ignored for any individual rule
# in this example, test files are ignored
ignore:
files:
- "*_test.rego"
Read Regal's configuration documentation for more information.