Add basic outline panel docs (#18674)

Bandaid to: #18672 Release Notes: - Added basic outline panel docs
zed-industries · Oct 3, 2024 · c48d4db · c48d4db
1 parent 19b1866
commit c48d4db
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -22,6 +22,7 @@
 # Using Zed
 
 - [Multibuffers](./multibuffers.md)
+- [Outline Panel](./outline-panel.md)
 - [Code Completions](./completions.md)
 - [Channels](./channels.md)
 - [Collaboration](./collaboration.md)

diff --git a/docs/src/outline-panel.md b/docs/src/outline-panel.md
@@ -0,0 +1,26 @@
+# Outline Panel
+
+In addition to the modal outline (`cmd-shift-o`), Zed offers an outline panel. The outline panel can be deployed via `cmd-shift-b`, or via the `Outline Panel` button in the status bar.
+
+When viewing a "singleton" buffer, the outline panel works similarly to that of the outline modal - it displays the outline of the current buffer's symbols, as reported by tree-sitter. Clicking on an entry allows you to jump to the associated section in the file. The outline view will also automatically scroll to the section associated with the current cursor position within the file.
+
+![Using the outline panel in a singleton buffer](https://zed.dev/img/outline-panel/singleton.png)
+
+The outline panel truly excels when used with multi-buffers. Here are some examples of its versatility:
+
+1. Project Search Results:
+
+Get an overview of search results across your project.
+![Using the outline panel in a project search multi-buffer](https://zed.dev/img/outline-panel/project-search.png)
+
+2. Project Diagnostics:
+
+View a summary of all errors and warnings reported by the language server.
+![Using the outline panel while viewing project diagnostics multi-buffer](https://zed.dev/img/outline-panel/project-diagnostics.png)
+
+3. Find All References:
+
+Quickly navigate through all references when using the `editor: find all references` action.
+![Using the outline panel while viewing `find all references` multi-buffer](https://zed.dev/img/outline-panel/find-all-references.png)
+
+The outline view provides a great way to quickly navigate to specific parts of your code and helps you maintain context when working with large result sets in multi-buffers.