mirrors/zed
1
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2025-02-09 12:01:58 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

docs: Standardize "Note" blockquote usage (#11724)

Browse source 
Standardize the blockquote "Notes" usage, so all places are using the
`>` blockquote notation, as well as a consistent style for the "Note"
word.

PS: Thought that bolding the word "**Note**" would make for a higher
visual distinction, so went for it in all existing cases! No strong
feelings, though; happy to roll back to just "Note:" if that's
preferrable!

Release Notes:

- N/A
This commit is contained in:
Danilo Leal 2024-05-13 10:02:44 -03:00 committed by GitHub
parent 76139330e3
commit 2e8197ce6e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/src/assistant-panel.md
View file

@ -2,7 +2,7 @@
The assistant panel provides you with a way to interact with OpenAI's large language models. The assistant is good for various tasks, such as generating code, asking questions about existing code, and even writing plaintext, such as emails and documentation. To open the assistant panel, toggle the right dock by using the `workspace: toggle right dock` action in the command palette (`cmd-shift-p`).
_Note: A default binding can be set to toggle the right dock via the settings._
> **Note**: A default binding can be set to toggle the right dock via the settings.
## Setup

8
docs/src/languages/javascript.md
View file

@ -64,10 +64,10 @@ You can also only execute a single ESLint rule when using `fixAll`:
}
```
**Note:** the other formatter you have configured will still run, after ESLint.
So if your language server or prettier configuration don't format according to
ESLint's rules, then they will overwrite what ESLint fixed and you end up with
errors.
> **Note:** the other formatter you have configured will still run, after ESLint.
> So if your language server or prettier configuration don't format according to
> 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 (requires Zed `0.130.x`):

6
docs/src/remote-development.md
View file

@ -12,7 +12,7 @@ Currently the two instances connect via Zed's servers, but we intend to build pe
## Setup
> NOTE: You must be in the alpha program to see this UI. The instructions will likely change as the feature gets closer to launch.
> **Note**: You must be in the alpha program to see this UI. The instructions will likely change as the feature gets closer to launch.
1. Open the projects dialog with `cmd-option-o` and then click "Connect…".
2. Click "Add Server"
@ -23,11 +23,11 @@ Currently the two instances connect via Zed's servers, but we intend to build pe
```
5. On the remote machine, paste the instructions from step 3.
> NOTE: Currently you must keep this process open. We are working on making it background itself.
> **Note**: Currently you must keep this process open. We are working on making it background itself.
> In the meantime, you can run `nohup zed --dev-server-token YY.XXX >~/.zed-log 2>&1 &`
6. On your laptop you can now open folders on the remote machine.
> NOTE: Zed does not currently handle opening very large directories (e.g. `/` or `~` that may have >100,000 files) very well. We are working on improving this, but suggest in the meantime opening only specific projects, or subfolders of very large mono-repos.
> **Note**: Zed does not currently handle opening very large directories (e.g. `/` or `~` that may have >100,000 files) very well. We are working on improving this, but suggest in the meantime opening only specific projects, or subfolders of very large mono-repos.
## Known Limitations