docs: update documentation

Signed-off-by: ldelossa <louis.delos@gmail.com>

Author: ldelossa

README.md

@@ -12,20 +12,22 @@
 
 ![calltree screenshot](./contrib/calltree-screenshot.png)
 
-# Calltree
+# Calltree.nvim
 
-Calltree implements the missing "call-hierarchy" tree UI seen in other popular IDE's
+Calltree.nvim implements the missing "call-hierarchy" tree UI seen in other popular IDEs
 such as Pycharm and VSCode.
 
-Calltree allows you to start at a root symbol and discover the callers or callees of it.
+Calltree.nvim allows you to start at a root symbol and discover the callers or callee's of it.
 
-Subsequently, you can drill down the tree futher to discover the "callers-of-caller" or 
-the "callees-of-callee". 
+Subsequently, you can drill down the tree further to discover the "callers-of-caller" or 
+the "callee's-of-callee". 
 
-This relationship forms a tree and this is exactly how Calltree works, keeping an in
+This relationship forms a tree and this is exactly how Calltree.nvim works, keeping an in
 memory representation of the call tree and writing the tree out to an outline form when
 requested.
 
+Additionally, Calltree.nvim provides a live document outline UI to further help the navigation of a codebase.
+
 # Usage
 
 ## Get it
@@ -40,26 +42,26 @@ Plug:
 Call the setup function from anywhere you configure your plugins from.
 
 Configuration dictionary is explained in ./doc/calltree.txt (:h calltree-config)
+
 ```
 require('calltree').setup({})
 ```
 
 ## Use it
 
-The setup function hooks directly into the "textDocument/incomingCalls" and "textDocument/outgoingCalls" 
-LSP handlers. 
+The setup function hooks directly into the "textDocument/incomingCalls", "textDocument/outgoingCalls", and "textDocument/documentSymbol" LSP handlers. 
 
 To start a call tree use the LSP client just like you're used to:
 
 ```
-:lua vim.lsp.buf.incoming_calls
-:lua vim.lsp.buf.outgoing_calls
+:lua vim.lsp.buf.incoming_calls()
+:lua vim.lsp.buf.outgoing_calls()
+:lua vim.slp.buf.document_symbol() (symboltree outline)
 ```
 
 You most likely have key mappings set for this if you're using the lsp-config.
 
-Once the calltree is open you can expand and collapse symbols to discover a total call
-hierarchy in an intuitative way.
+Once the calltree or symboltree is open you can expand and collapse symbols to discover a total call hierarchy or document outline in an intuitative way.
 
 Use ":CTExpand" and ":CTCollapse" to achieve this.
 
@@ -69,13 +71,13 @@ Check out (:h calltree) for all the details.
 
 This plugin aims to be super simple and do one thing very well. 
 
-There are a few features which add a bit more to the basic calltree usage. 
+There are a few features which add a bit more to the basic usage. 
 
-## Switching Directions
+## Switching Directions (calltree)
 
-The ":CTSwitch" command will focus and inverse the call tree (move from outgoing to incoming for example) for the symbol under the curosor. 
+The ":CTSwitch" command will focus and inverse the call tree (move from outgoing to incoming for example) for the symbol under the cursor. 
 
-## Focusing
+## Focusing (calltree)
 
 The ":CTFocus" command will re-parent the symbol under the cursor, making it root. 
 
@@ -87,26 +89,42 @@ The ":CTHover" will show hover info for the given symbol.
 
 ## Jump
 
-Calltree supports jumping to the symbol. 
+Calltree.nvim supports jumping to the symbol. 
 
 The ":CTJump" command will do this. 
 
 How jumping occurs is controlled by the config, see (h: calltree-config)
 
+Jumping will set highlights in the source file, to clear these use ":CTClearHL".
+
 ## Icons
 
-Nerd font icons along with codicons are currently supported. 
+Nerd font icons along with Codicons are currently supported. 
 
 You'll need a patched font for them to work correctly. see (h: calltree-config)
 
 ## Symbol Outline
 
-Because the tree module can be used for symbols as well calltree implements a live symbol outline of the focused buffer.
+Because the tree module can be used for symbols as well Calltree.nvim implements a live symbol outline of the focused buffer.
 
 Expanding and collapsing nodes is done with the same commands as the call hierarchy tree. 
 
 The UI works together and will always ensure a static layout with call hierarchy on top/left and symbols on bottom/right.
 
+## Unified Panel
+
+It's possible to treat Calltree.nvim's UI as a persistent but collapsible panel. 
+
+This would be similar to VSCode and JetBrain IDEs, where an informational panel is present on the left, bottom, right, or top of the editor depending on configuration. 
+
+When enabling the unified panel, both the symboltree (document symbol outline) and the calltree (any recently requested call hierarchy outline) are always displayed together. 
+
+The "CTPanel" command may be used to open and collapse the unified panel when desired. 
+
+The configuration options `unified_panel` and `auto_open_panel` can be set to true to ensure the unified panel is opened when LSP requests are made and the unified panel is opened on Neovim's start, respectively.
+
+The unified panel is completely opt-in. By keeping the `unified_panel` and `auto_open_panel` options false only the respectively Calltree.nvim UI elements will open when LSP requests are made. Furthermore, you can use ":CTPanel" freely without either option above set, if you'd like to "sometimes" use the unified panel without any constraints.
+
 ## Demo
 
 [![Calltree Demonstration]()](https://user-images.githubusercontent.com/5642902/142293639-aa0d97a1-e3b0-4fc4-942e-108bfaa18793.mp4)

doc/calltree.txt

@@ -16,12 +16,15 @@ License:  MIT license
 ====================================================================================
 CONTENTS                                                         *calltree-contents*
 
-  1. Intro........................................|calltree-intro|
-  2. Usage........................................|caltree-usage|
-  3. Commands.....................................|calltree-commands|
-  4. Mappings.....................................|calltree-mappings|
-  5. Config.......................................|calltree-config|
-  6. Highlights...................................|calltree-highlights|
+  1     Intro.........................................|calltree-intro|
+  2     Usage.........................................|caltree-usage|
+  2.1    Unified Panel................................|calltree-unified-panel|  
+  3     Commands......................................|calltree-commands|
+  4     Mappings......................................|calltree-mappings|
+  5     Config........................................|calltree-config|
+  6     Highlights....................................|calltree-highlights|
+  6.1    Icon Highlights..............................|calltree-icon-highlights|
+  6.2    UI Highlights................................|calltree-ui-highlights|
 
 ====================================================================================
 INTRODUCTION                                                        *calltree-intro*
@@ -65,19 +68,19 @@ and "vim.lsp.buf.outgoing_calls" will open the calltree window.
 
 The calltree UI can be used as a unified panel or as individual elements. 
 
-A unified panel would feel similar to IDE's such as VSCode where you can "hide"
-and "unhide" a persistent informational panel. Both the symbol tree and the call tree will
-always be present in the toggled panel, unless you manually close a window. 
-Toggling the panel will recreate any closed windows. This functionality
-is provided via the "CTPanel" command.
+                                                            *calltree-unified-panel*
 
-If you'd rather use each individual component separately this is possible
-too. Utilize the "CTOpen/CTClose" and "STOpen/STClose" commands. These commands
-will only open and close the respective UI components.
+It's possible to treat Calltree.nvim's UI as a persistent but collapsible panel. 
 
-By default performing a "call-hierarchy" request for incoming or outgoing calls
-does not assume a unified panel. If you'd like it to open the unified panel on LSP requests
-then set "unified_panel" to true in the config. See *calltree-config*
+This would be similar to VSCode and JetBrain IDEs, where an informational panel is present on the left, bottom, right, or top of the editor depending on configuration. 
+
+When enabling the unified panel, both the symboltree (document symbol outline) and the calltree (any recently requested call hierarchy outline) are always displayed together. 
+
+The "CTPanel" command may be used to open and collapse the unified panel when desired. 
+
+The configuration options `unified_panel` and `auto_open_panel` can be set to true to ensure the unified panel is opened when LSP requests are made and the unified panel is opened on Neovim's start, respectively.
+
+The unified panel is completely opt-in. By keeping the `unified_panel` and `auto_open_panel` options false only the respectively Calltree.nvim UI elements will open when LSP requests are made. Furthermore, you can use ":CTPanel" freely without either option above set, if you'd like to "sometimes" use the unified panel without any constraints.
 
 From there check out *calltree-commands* to manipulate the calltree UI.