vrr/zed - VRR Forge

vrr/zed

Fork 0

mirror of https://github.com/zed-industries/zed.git synced 2026-05-31 21:31:32 +00:00

Commit graph

Author	SHA1	Message	Date
morgankrey	6daa541e77	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	2026-02-17 20:58:17 -06:00
Miguel Raz Guzmán Macedo	b3dd51560b	docs: Fix broken links in docs with lychee (#42404 ) Lychee is a [Rust based](https://lychee.cli.rs) async parallel link checker. I ran it against the codebase to suss out stale links and fixed those up. There's currently 2 remaining cases that I don't know how to resolve: 1. https://flathub.org/apps/dev.zed.Zed - nginx is giving a 502 bad gateway 2. https://github.com/zed-industries/zed/actions/workflows/ci.yml/badge.svg - I don't want to mess with the CI pipeline in this PR. Once again, I'll punt to the Docs Czar to see if this gets incorporated into CI later. --- ## Running `lychee` locally: ``` cargo binstall -y lychee lychee . ``` --- Release Notes: - N/A Signed-off-by: mrg <miguelraz@ciencias.unam.mx>	2025-11-11 13:55:02 +01:00
Joseph T. Lyons	219ae05d1f	Add a doc on crafting release notes (#40557 ) Release Notes: - N/A	2025-10-18 05:09:27 +00:00

Author

SHA1

Message

Date

morgankrey

6daa541e77

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

2026-02-17 20:58:17 -06:00

Miguel Raz Guzmán Macedo

b3dd51560b

docs: Fix broken links in docs with lychee (#42404 )

Lychee is a [Rust based](https://lychee.cli.rs) async parallel link
checker.

I ran it against the codebase to suss out stale links and fixed those
up.

There's currently 2 remaining cases that I don't know how to resolve:

1. https://flathub.org/apps/dev.zed.Zed - nginx is giving a 502 bad
gateway
2.
https://github.com/zed-industries/zed/actions/workflows/ci.yml/badge.svg
- I don't want to mess with the CI pipeline in this PR.

Once again, I'll punt to the Docs Czar to see if this gets incorporated
into CI later.

---

## Running `lychee` locally:

```
cargo binstall -y lychee
lychee .
```

---
Release Notes:

- N/A

Signed-off-by: mrg <miguelraz@ciencias.unam.mx>

2025-11-11 13:55:02 +01:00

Joseph T. Lyons

219ae05d1f

Add a doc on crafting release notes (#40557 )

Release Notes:

- N/A

2025-10-18 05:09:27 +00:00

3 commits