docs: Apply documentation standards across all docs (#49177)
## 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
This commit is contained in:
1 parent
9743fe7dfd
commit
6daa541e77
142 files changed
+1947
-489
No files matched your search
@@ -1,3 +1,8 @@
|
||||
---
|
||||
title: Lua
|
||||
description: "Configure Lua language support in Zed, including language servers, formatting, and debugging."
|
||||
---
|
||||
|
||||
# Lua
|
||||
|
||||
Lua support is available through the [Lua extension](https://github.com/zed-extensions/lua).
|
||||
@@ -7,7 +12,7 @@ Lua support is available through the [Lua extension](https://github.com/zed-exte
|
||||
|
||||
## luarc.json
|
||||
|
||||
To configure LuaLS you can create a `.luarc.json` file in the root of your workspace.
|
||||
To configure LuaLS you can create a `.luarc.json` file in the root of your project.
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
@@ -88,7 +93,7 @@ Then in your `.luarc.json`:
|
||||
|
||||
To enable [Inlay Hints](../configuring-languages.md#inlay-hints) for LuaLS in Zed
|
||||
|
||||
1. Add the following to your Zed settings.json:
|
||||
1. Configure inlay hints in Settings ({#kb zed::OpenSettings}) under Languages > Lua, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
"languages": {
|
||||
@@ -118,7 +123,7 @@ To enable auto-formatting with your LuaLS (provided by [CppCXY/EmmyLuaCodeStyle]
|
||||
}
|
||||
```
|
||||
|
||||
Then add the following to your Zed `settings.json`:
|
||||
Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > Lua, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
@@ -138,7 +143,7 @@ You can customize various EmmyLuaCodeStyle style options via `.editorconfig`, se
|
||||
Alternatively to use [StyLua](https://github.com/JohnnyMorganz/StyLua) for auto-formatting:
|
||||
|
||||
1. Install [StyLua](https://github.com/JohnnyMorganz/StyLua): `brew install stylua` or `cargo install stylua --features lua52,lua53,lua54,luau,luajit` (feel free to remove any Lua versions you don't need).
|
||||
2. Add the following to your `settings.json`:
|
||||
2. Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > Lua, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
@@ -162,7 +167,7 @@ Alternatively to use [StyLua](https://github.com/JohnnyMorganz/StyLua) for auto-
|
||||
}
|
||||
```
|
||||
|
||||
You can specify various options to StyLua either on the command line above (like `--syntax=Lua54`) or in a `stylua.toml` in your workspace:
|
||||
You can specify various options to StyLua either on the command line above (like `--syntax=Lua54`) or in a `stylua.toml` in your project:
|
||||
|
||||
```toml
|
||||
syntax = "Lua54"
|
||||
|
||||
Reference in new issue
Block a user