docs: Adjust the channels page a bit (#31636)

All the docs related to collaboration could use some deep revamp, but
this PR is just formatting tweaks so it doesn't look broken. The images
weren't showing at all!

Release Notes:

- N/A
This commit is contained in:
Danilo Leal 2025-05-28 19:27:47 -03:00 committed by GitHub
parent 469824c350
commit 1e25249055
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,7 +2,7 @@
At Zed we believe that great things are built by great people working together. We have designed Zed to help every individual work faster and to help teams of people work together more effectively.
### Overview
## Overview
Channels provide a way to streamline collaborating for software engineers in many ways, but particularly:
@ -11,11 +11,9 @@ Channels provide a way to streamline collaborating for software engineers in man
- Refactoring you can have multiple people join in on large refactoring without fear of conflict.
- Ambient awareness you can see what everyone else is working on with no need for status emails or meetings.
### Channels
## Channels
To open the collaboration panel hit `cmd-shift-c` (or `cmd-shift-p “collab panel: toggle focus”`).
<figure><img src="../.gitbook/assets/channels-1.png" alt=""><figcaption></figcaption></figure>
To open the collaboration panel hit {#kb collab_panel::ToggleFocus} or `collab panel: toggle focus`.
Each channel corresponds to an ongoing project or work-stream. You can see whos in a channel as their avatars will show up in the sidebar. This makes it easy to see what everyone is doing and where to find them if needed.
@ -23,29 +21,25 @@ You can create as many channels as you need. As in the example above, you can mi
Joining a channel adds you to a shared room where you can work on projects together.
### Sharing projects
## Sharing projects
After joining a channel, you can `Share` a project with the other people there. This will enable them to edit the code hosted on your machine as though they had it checked out locally.
<figure><img src="../.gitbook/assets/channels-2.png" alt=""><figcaption></figcaption></figure>
When you are editing someone elses project, you still have the full power of the editor at your fingertips, you can jump to definitions, use the AI assistant, and see any diagnostic errors. This is extremely powerful for pairing, as one of you can be implementing the current method while the other is reading and researching the correct solution to the next problem. And, because you have your own config running, it feels like youre using your own machine.
See [our collaboration documentation](./collaboration.md) for more details about how this works.
### Notes
## Notes
Each channel has a notes file associated with it to keep track of current status, new ideas, or to collaborate on building out the design for the feature that youre working on before diving into code.
<figure><img src="../.gitbook/assets/channels-3.png" alt=""><figcaption></figcaption></figure>
This is similar to a Google Doc, except powered by Zed's collaborative software and persisted to our servers.
### Chat
## Chat
The chat is also there for quickly sharing context without a microphone, getting questions answered, or however else you'd want to use a chat channel.
### Inviting people
## Inviting people
By default, channels you create can only be accessed by you. You can invite collaborators by right clicking and selecting `Manage members`.
@ -53,7 +47,7 @@ When you have channels nested under each other, permissions are inherited. For i
Once you have added someone, they can either join your channel by clicking on it in their Zed sidebar, or you can share the link to the channel so that they can join directly.
### Livestreaming & Guests
## Livestreaming & Guests
A Channel can also be made Public. This allows anyone to join the channel by clicking on the link.