morgankrey
9168df6260
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
2f0d57dbae
typo: Use tips from proselint ( #42362 )
...
I ran [proselint](https://github.com/amperser/proselint ) (recommended by
cURL author [Daniel
Stenberg](https://daniel.haxx.se/blog/2022/09/22/taking-curl-documentation-quality-up-one-more-notch/ ))
against all the `.md` files in the codebase to see if I could fix some
easy typos.
The tool is noisier than I would like and picking up the overrides to
the default config in a `.proselintrc.json` was much harder than I
expected.
There's many other small nits [1] that I believe are best left to your
docs czar whenever they want to consider incorporating a tool like this
into big releases or CI, but these seemed like small wins for now to
open a conversation about a tool like proselint.
---
[1]: Such nits include
- incosistent 1 or 2 spaces
- "color" vs "colour"
- ab/use of `very`
- awkward or superfluous phrasing.
Release Notes:
- N/A
Signed-off-by: mrg <miguelraz@ciencias.unam.mx >
2025-11-10 17:51:44 +02:00
Marshall Bowers
f84779a483
docs: Fix casing of "Tree-sitter" ( #25427 )
...
This PR fixes the casing of "Tree-sitter" in the docs.
It is "Tree-sitter", not "Tree Sitter" or "Tree-Sitter".
Release Notes:
- N/A
2025-02-23 15:30:10 +00:00
Marshall Bowers
f0a9852f51
ocaml: Extract to zed-extensions/ocaml repository ( #20825 )
...
This PR extracts the OCaml extensions to the
[zed-extensions/ocaml](https://github.com/zed-extensions/ocaml )
repository.
Release Notes:
- N/A
2024-11-18 11:30:45 -05:00
+4
d4bbb9d30d
Docs Party 2024 ( #15876 )
...
Co-authored-by: Raunak Raj <nkray21111983@gmail.com >
Co-authored-by: Thorsten Ball <mrnugget@gmail.com >
Co-authored-by: Bennet <bennet@zed.dev >
Co-authored-by: Marshall Bowers <elliott.codes@gmail.com >
Co-authored-by: Joseph T Lyons <JosephTLyons@gmail.com >
Co-authored-by: Mikayla <mikayla@zed.dev >
Co-authored-by: Jason <jason@zed.dev >
Co-authored-by: Antonio Scandurra <me@as-cii.com >
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com >
Co-authored-by: Marshall <marshall@zed.dev >
Co-authored-by: Nathan Sobo <nathan@zed.dev >
Co-authored-by: Jason Mancuso <7891333+jvmncs@users.noreply.github.com >
Co-authored-by: Piotr Osiewicz <24362066+osiewicz@users.noreply.github.com >
2024-08-09 13:37:54 -04:00
Marshall Bowers
9d85abb36e
docs: Update language docs and include links in the sidebar ( #13828 )
...
This PR updates the supported language docs and adds them to the sidebar
for better discoverability.
Release Notes:
- N/A
2024-07-04 11:08:38 -04:00
Marshall Bowers
aba1003e47
docs: Remove $ in shell commands ( #13266 )
...
This PR removes the `$` from the shell commands in the OCaml docs, as we
don't use them anywhere else.
Release Notes:
- N/A
2024-06-19 10:14:56 -04:00
Marshall Bowers
478419574c
Format docs with Prettier ( #8134 )
...
This PR formats the docs with Prettier.
Release Notes:
- N/A
2024-02-21 13:21:22 -05:00
Rashid Almheiri
33a2bd04f2
docs: Update OPAM installation instructions ( #7510 )
...
Use the new installation procedures located at
https://ocaml.org/install .
Release Notes:
- N/A
2024-02-07 14:12:53 -05:00
Rashid Almheiri
17adb2b5c3
Add OCaml support ( #6929 )
...
This pull request implements support for the [OCaml
Language](https://ocaml.org/ ).
### Additions
- [x]
[tree-sitter-ocaml](https://github.com/tree-sitter/tree-sitter-ocaml )
grammar
- [x] Highlight, Indents, Outline queries
- [x] A new file icon for .ml(i) files. Based on
[ocaml/ocaml-logo](https://github.com/ocaml/ocaml-logo/blob/master/Colour/SVG/colour-transparent-icon.svg )
- [x] LSP Integration with
[ocaml-language-server](https://github.com/ocaml/ocaml-lsp )
- [x] Completion Labels
- [x] Symbol Labels
### Bug Fixes
- [x] Improper parsing of LSP headers.
### Missing [will file a separate issue]
- Documentation on completionItem, requires: `completionItem/resolve`
with support for `documentation` as a provider.
### Screenshots
<details><summary>Zed</summary>
<img width="1800" alt="Screenshot 2024-02-01 at 03 33 20"
src="https://github.com/zed-industries/zed/assets/69181766/e17c184e-203e-40c3-a08f-4de46226b79c ">
</details>
Release Notes:
- Added OCaml Support
([#5316 ](https://github.com/zed-industries/zed/issues/5316 )).
> [!NOTE]
> Partially completes #5316
> To complete #5316 :
> 1. addition of a reason tree-sitter grammar.
> 2. opam/esy integration, however it may be better as it's own plugin.
2024-02-02 16:58:07 +02:00
morgankrey
