diff --git a/docs/src/development/glossary.md b/docs/src/development/glossary.md index b3ff24464c12d9c00adb1e509c41f123dba3cb8c..34172ec9a590fdae537ff78920e1fadda2c331fa 100644 --- a/docs/src/development/glossary.md +++ b/docs/src/development/glossary.md @@ -79,15 +79,17 @@ h_flex() - `Pane`: An area in the `Center` where we can place items, such as an editor, multi-buffer or terminal (see image below). - `Panel`: An `Entity` implementing the `Panel` trait. These can be placed in a `Dock`. In the image below we see the: `ProjectPanel` in the left dock, the `DebugPanel` in the bottom dock, and `AgentPanel` in the right dock. Note `Editor` does not implement `Panel` and hence is not a `Panel`. - `Dock`: A UI element similar to a `Pane` which can be opened and hidden. There can be up to 3 docks open at a time, left right and below the center. A dock contains one or more `Panel`s not `Pane`s. (see image). - image + +Screenshot for the Pane and Dock features - `Project`: One or more `Worktree`s - `Worktree`: Represents either local or remote files. - image + +Screenshot for the Worktree feature - [Multibuffer](https://zed.dev/docs/multibuffers): A list of Editors, a multi-buffer allows editing multiple files simultaneously. A multi-buffer opens when an operation in Zed returns multiple locations, examples: _search_ or _go to definition_. See project search in the image below. -image +Screenshot for the MultiBuffer feature ## Editor @@ -109,7 +111,7 @@ h_flex() - `debugger::Session`: Is an entity that manages the lifecycle of a debug session and communication with DAPS - `BreakpointStore`: Is an entity that manages breakpoints states in local and remote instances of Zed - `DebugSession`: Manages a debug session's UI and running state -- `RunningState`: Directily manages all the views of a debug session +- `RunningState`: Directly manages all the views of a debug session - `VariableList`: The variable and watch list view of a debug session - `Console`: TODO - `Terminal`: TODO