mirror of
https://github.com/zed-industries/zed.git
synced 2026-06-01 05:51:14 +00:00
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:
parent
9743fe7dfd
commit
6daa541e77
142 changed files with 1947 additions and 489 deletions
|
|
@ -1,3 +1,8 @@
|
|||
---
|
||||
title: JavaScript
|
||||
description: "Configure JavaScript language support in Zed, including language servers, formatting, and debugging."
|
||||
---
|
||||
|
||||
# JavaScript
|
||||
|
||||
JavaScript support is available natively in Zed.
|
||||
|
|
@ -14,7 +19,9 @@ But many JavaScript projects use other command-line code-formatting tools, such
|
|||
You can use one of these tools by specifying an _external_ code formatter for JavaScript in your settings.
|
||||
See [the configuration docs](../reference/all-settings.md) for more information.
|
||||
|
||||
For example, if you have Prettier installed and on your `PATH`, you can use it to format JavaScript files by adding the following to your `settings.json`:
|
||||
For example, if you have Prettier installed and on your `PATH`, you can use it to format JavaScript files.
|
||||
|
||||
Configure formatting in Settings ({#kb zed::OpenSettings}) under Languages > JavaScript, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
|
|
@ -44,7 +51,9 @@ Zed uses [tree-sitter/tree-sitter-jsdoc](https://github.com/tree-sitter/tree-sit
|
|||
|
||||
## ESLint
|
||||
|
||||
You can configure Zed to format code using `eslint --fix` by running the ESLint code action when formatting:
|
||||
You can configure Zed to format code using `eslint --fix` by running the ESLint code action when formatting.
|
||||
|
||||
Configure code actions on format in Settings ({#kb zed::OpenSettings}) under Languages > JavaScript, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
|
|
@ -86,8 +95,9 @@ You can also only execute a single ESLint rule when using `fixAll`:
|
|||
> ESLint's rules, then they will overwrite what ESLint fixed and you end up with
|
||||
> errors.
|
||||
|
||||
If you **only** want to run ESLint on save, you can configure code actions as
|
||||
the formatter:
|
||||
If you **only** want to run ESLint on save, you can configure code actions as the formatter.
|
||||
|
||||
Configure in Settings ({#kb zed::OpenSettings}) under Languages > JavaScript, or add to your settings file:
|
||||
|
||||
```json [settings]
|
||||
{
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue