branch: externals/ellama
commit f93f777efb3b15236edf970161c4d196769d4444
Author: Sergey Kostyaev <sskosty...@gmail.com>
Commit: Sergey Kostyaev <sskosty...@gmail.com>
Add ephemeral context support to documentation
Added support for an ephemeral context, which is temporary and only
available
for a single request. Updated README.org and ellama.info to reflect these
changes. Also updated the transient menus for context management to include
options for managing the ephemeral context.
Fix #309
---
README.org | 18 ++++++++++-------
ellama.info | 67 +++++++++++++++++++++++++++++++++----------------------------
2 files changed, 47 insertions(+), 38 deletions(-)
diff --git a/README.org b/README.org
index c1d7ab2918..eed1ffa995 100644
--- a/README.org
+++ b/README.org
@@ -365,7 +365,9 @@ which may not always be appropriate.
A “global context” is maintained, which is a collection of text blocks
accessible to the LLM when responding to prompts. This global context is
-prepened to your prompt before transmission to the LLM.
+prepended to your prompt before transmission to the LLM. Additionally, Ellama
+supports an "ephemeral context," which is temporary and only available for a
+single request.
** Transient Menus for Context Management
@@ -378,12 +380,14 @@ The Context Commands transient menu is structured as
follows:
Context Commands:
-- Add: Provides options for adding content to the global context.
- - “b” "Add Buffer" ~ellama-context-add-buffer~
- - “d” "Add Directory" ~ellama-context-add-directory~
- - “f” "Add File" ~ellama-context-add-file~
- - “s” "Add Selection" ~ellama-context-add-selection~
- - “i” "Add Info Node" ~ellama-context-add-info-node~
+- Options: Provides options for managing ephemeral context.
+ - “-e” "Use Ephemeral Context" ~--ephemeral~
+- Add: Provides options for adding content to the global or ephemeral context.
+ - “b” "Add Buffer" ~ellama-transient-add-buffer~
+ - “d” "Add Directory" ~ellama-transient-add-directory~
+ - “f” "Add File" ~ellama-transient-add-file~
+ - “s” "Add Selection" ~ellama-transient-add-selection~
+ - “i” "Add Info Node" ~ellama-transient-add-info-node~
- Manage: Provides options for managing the global context.
- “m” "Manage context" ~ellama-context-manage~ - Opens the context
management buffer.
diff --git a/ellama.info b/ellama.info
index 229a9e8913..9a305ef574 100644
--- a/ellama.info
+++ b/ellama.info
@@ -489,7 +489,9 @@ its pre-existing knowledge, which may not always be
appropriate.
A “global context” is maintained, which is a collection of text blocks
accessible to the LLM when responding to prompts. This global context
-is prepened to your prompt before transmission to the LLM.
+is prepended to your prompt before transmission to the LLM.
+Additionally, Ellama supports an "ephemeral context," which is temporary
+and only available for a single request.
* Menu:
@@ -512,12 +514,15 @@ The Context Commands transient menu is structured as
follows:
Context Commands:
- • Add: Provides options for adding content to the global context.
- • “b” "Add Buffer" ‘ellama-context-add-buffer’
- • “d” "Add Directory" ‘ellama-context-add-directory’
- • “f” "Add File" ‘ellama-context-add-file’
- • “s” "Add Selection" ‘ellama-context-add-selection’
- • “i” "Add Info Node" ‘ellama-context-add-info-node’
+ • Options: Provides options for managing ephemeral context.
+ • “-e” "Use Ephemeral Context" ‘--ephemeral’
+ • Add: Provides options for adding content to the global or ephemeral
+ context.
+ • “b” "Add Buffer" ‘ellama-transient-add-buffer’
+ • “d” "Add Directory" ‘ellama-transient-add-directory’
+ • “f” "Add File" ‘ellama-transient-add-file’
+ • “s” "Add Selection" ‘ellama-transient-add-selection’
+ • “i” "Add Info Node" ‘ellama-transient-add-info-node’
• Manage: Provides options for managing the global context.
• “m” "Manage context" ‘ellama-context-manage’ - Opens the
context management buffer.
@@ -1412,30 +1417,30 @@ Node: Commands8621
Node: Keymap14965
Node: Configuration17798
Node: Context Management23139
-Node: Transient Menus for Context Management23932
-Node: Managing the Context25390
-Node: Considerations26165
-Node: Minor modes26758
-Node: ellama-context-header-line-mode28746
-Node: ellama-context-header-line-global-mode29571
-Node: ellama-context-mode-line-mode30291
-Node: ellama-context-mode-line-global-mode31139
-Node: Ellama Session Header Line Mode31843
-Node: Enabling and Disabling32412
-Node: Customization32859
-Node: Ellama Session Mode Line Mode33147
-Node: Enabling and Disabling (1)33732
-Node: Customization (1)34179
-Node: Using Blueprints34473
-Node: Key Components of Ellama Blueprints35092
-Node: Creating and Managing Blueprints35699
-Node: Variable Management36680
-Node: Keymap and Mode37149
-Node: Transient Menus38085
-Node: Running Blueprints programmatically38631
-Node: Acknowledgments39218
-Node: Contributions39931
-Node: GNU Free Documentation License40315
+Node: Transient Menus for Context Management24047
+Node: Managing the Context25661
+Node: Considerations26436
+Node: Minor modes27029
+Node: ellama-context-header-line-mode29017
+Node: ellama-context-header-line-global-mode29842
+Node: ellama-context-mode-line-mode30562
+Node: ellama-context-mode-line-global-mode31410
+Node: Ellama Session Header Line Mode32114
+Node: Enabling and Disabling32683
+Node: Customization33130
+Node: Ellama Session Mode Line Mode33418
+Node: Enabling and Disabling (1)34003
+Node: Customization (1)34450
+Node: Using Blueprints34744
+Node: Key Components of Ellama Blueprints35363
+Node: Creating and Managing Blueprints35970
+Node: Variable Management36951
+Node: Keymap and Mode37420
+Node: Transient Menus38356
+Node: Running Blueprints programmatically38902
+Node: Acknowledgments39489
+Node: Contributions40202
+Node: GNU Free Documentation License40586
End Tag Table
