zed-industries / docs Goto Github PK

The images are in assets/collaboration, so they must just be linked wrong.

Is https://docs.zed.dev/ replaced by https://zed.dev/docs/configuring-zed?

If so, do you plan on removing this repo once the docs are completed on the other site?

Make it clear in the docs that diagnostics/RA only works on cargo-based projects. Rust analyzer only works out of the box on cargo-based projects. This is a RA thing, but might be worth calling out for people just exploring Rust to test out Zed.

We are in the middle of reworking the UI a bit for collaboration. While our collaboration documentation might be a bit outdated and could use some work, we would have to update them again pretty quickly after. In order to avoid this extra work, we will just be skipping updating documentation on collaboration until this chunk of work is done. When this issue is closed and unpinned, it can be assumed that we will be ready to accept PRs related to collaboration documentation.

Thanks

https://zed.dev/docs/general/telemetry lists

requests are rate-limiteed to avoid using significant network bandwidth

<3

(slightly related to #6 should that section be reworded)

Update all documentation (text and screenshots) that talk about the invite system.

• zed-industries/zed#6047

GitBook seems to have an option for dark mode: https://docs.gitbook.com/tour/customization/space-customization#theme-mode

Since the editor and the website are in dark mode by default, too, I think I'd make sense for the docs as well.

Check for existing issues

• Completed

Page link

https://zed.dev/docs/languages/python

Description

- A python virtual environment allows you store all
+ A python virtual environment allows you to store all

- any directory that contains one or more a virtual environment directories
+ any directory that contains one or more virtual environment directories

- you can use it format Python files
+ you can use it to format Python files

...not really a typo, but the first half of the page uses the word directory, when suddenly the For example, [...] section uses folder. Slightly confusing to me, given that the "magic phrase" virtual environment directory appears very often in the theoretical explanation, and that pattern is broken in the example.

<3

I couldn't find a repo for https://zed.dev/features

while keeping it's contents
the top right of it's pane
uses Alacritty as it's backend

None of these is an abbreviation of "it is" or "it has", so no apostrophe. ("Its" is already the possessive pronoun, just as you don't write "I like hi's editor.") Cheers.

Related to zed-industries/zed#5748 which was specifically for git, but this is not restricted to using it for git.

• How to install the CLI
• How to set Zed to be your default EDITOR on macOS

As there doesn't seem to be a place to submit issues/PRs for the main page (https://zed.dev), here's a minor typo:

/faq

• What are the release channels? - "onece" in body should be "once"

Check for existing issues

• Completed

Page link

https://zed.dev/docs/configuration/key-bindings

Description

Sometimes multiple keybindings for the same action are

• listed in one row: https://zed.dev/docs/configuration/key-bindings#workspace (see Toggle theme selctor for example (typo is not a quotation error, it's literally on the page :P))

  • sometimes before the comma there's a space (e.g. Open key map)
  • sometimes there's no space before the comma (e.g. Select next

• split up into multiple rows: https://zed.dev/docs/configuration/key-bindings#editor (e.g. Backspace or Select down)

This is sparkled throughout the whole document, not just bound to one place.

Joseph and I didn't get through all the screenshots yet. If someone wants to pick this up let me know, we have a specific process for screenshots now!

For users in companies where a security team manually validates allowed software lists, it would be a good idea to have a page explaining the different security-related elements, to help allowing Zed for the users.

Stuff that could be included (incomplete list):

• Where do community-related stuff live? On which servers (zed's? github's?)? Where are they hosted? (AWS?) Ex: users, calls, logs
• Do the multiplayer features and calls go through zed's server, or is it peer-to-peer? With which type of encryption, if any?
• Which filesystem / os rights does zed require to work in a minimal way? Which rights for all features?

I know some of these already exist in the current state of the docs, but grouping them all on a security-related page would definitely help adoption in heavily-regulated companies.

Thanks!

Check for existing issues

• Completed

Describe the bug

https://zed.dev/docs/tour says that cmd-9 opens contacts but it does not.

To reproduce

press cmd-9

or

go to https://zed.dev/docs/tour

Expected behavior

contacts should open

or

page should not say cmd-9 opens contacts

Environment

Zed 0.50.0 – /Applications/Zed.app
macOS 11.6.1
architecture x86_64

If applicable, add mockups / screenshots to help explain present your vision of the feature

No response

If applicable, attach your ~/Library/Logs/Zed/Zed.log file to this issue

No response

I wish somehow I was able to see the list of all available keyboard shortcuts.

The telemetry docs list

When we release the public beta, we'll provide the ability to opt out of telemetry, but during the alpha, it isn't configurable.

But the FAQ lists this instead:

If you don't authenticate, we currently send nothing to our servers.

If you are authenticated, you can still open a project in "offline mode" by clicking the lock next to your project in the contacts panel. At that point, we record the fact that you have a project open, but no other details.

Which sounds slightly confusing to me: On the one hand, telemetry isn't supposed to be configurable (and the ability to opt out will come in beta), but on the other hand it's possible to put a project offline or don't even authenticate and send nothing/barely anything. It's very possible I'm just missing something though!

I want to add this one
https://github.com/dart-lang/sdk/blob/main/pkg/analysis_server/tool/lsp_spec/README.md