branch: externals/ellama
commit 5224c91dc52290a5442188ce6b55911a4b9443a8
Author: Sergey Kostyaev <[email protected]>
Commit: Sergey Kostyaev <[email protected]>
Update documentation
---
README.org | 16 ++++++++----
ellama.info | 82 +++++++++++++++++++++++++++++++++----------------------------
2 files changed, 55 insertions(+), 43 deletions(-)
diff --git a/README.org b/README.org
index 89b7b62afb..fcae6f6111 100644
--- a/README.org
+++ b/README.org
@@ -132,11 +132,12 @@ More sophisticated configuration example:
- ~ellama-write~: This command allows you to generate text using an LLM. When
called interactively, it prompts for an instruction that is then used to
generate text based on the context. If a region is active, the selected
text
- is added to the context before generating the response.
+ is added to ephemeral context before generating the response.
- ~ellama-chat-send-last-message~: Send last user message extracted from
current ellama chat buffer.
- ~ellama-ask-about~: Ask Ellama about a selected region or the current
- buffer.
+ buffer. Automatically adds selected region or current buffer to ephemeral
+ context for one request.
- ~ellama-ask-selection~: Send selected region or current buffer to ellama
chat.
- ~ellama-ask-line~: Send current line to ellama chat.
@@ -149,7 +150,8 @@ More sophisticated configuration example:
Ellama.
- ~ellama-summarize-killring~: Summarize text from the kill ring.
- ~ellama-code-review~: Review code in a selected region or the current buffer
- using Ellama.
+ using Ellama. Automatically adds selected region or current buffer to
+ ephemeral context for one request.
- ~ellama-change~: Change text in a selected region or the current buffer
according to a provided change.
- ~ellama-make-list~: Create a markdown list from the active region or the
@@ -163,8 +165,8 @@ More sophisticated configuration example:
according to a provided change using Ellama.
- ~ellama-code-add~: Generate and insert new code based on description. This
function prompts the user to describe the code they want to generate. If a
- region is active, it includes the selected text as context for code
- generation.
+ region is active, it includes the selected text in ephemeral context for
+ code generation.
- ~ellama-code-edit~: Change selected code or code in the current buffer
according to a provided change using Ellama.
- ~ellama-code-improve~: Change selected code or code in the current buffer
@@ -408,6 +410,10 @@ 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.
+Some commands add context automatically as ephemeral context:
+~ellama-ask-about~, ~ellama-code-review~, ~ellama-write~, and
+~ellama-code-add~.
+
** Transient Menus for Context Management
Ellama provides a transient menu accessible through the main menu, offering a
diff --git a/ellama.info b/ellama.info
index be448f02d4..c8d1f92051 100644
--- a/ellama.info
+++ b/ellama.info
@@ -237,12 +237,13 @@ File: ellama.info, Node: Commands, Next: Keymap, Prev:
Installation, Up: Top
• ‘ellama-write’: This command allows you to generate text using an
LLM. When called interactively, it prompts for an instruction that
is then used to generate text based on the context. If a region is
- active, the selected text is added to the context before generating
- the response.
+ active, the selected text is added to ephemeral context before
+ generating the response.
• ‘ellama-chat-send-last-message’: Send last user message extracted
from current ellama chat buffer.
• ‘ellama-ask-about’: Ask Ellama about a selected region or the
- current buffer.
+ current buffer. Automatically adds selected region or current
+ buffer to ephemeral context for one request.
• ‘ellama-ask-selection’: Send selected region or current buffer to
ellama chat.
• ‘ellama-ask-line’: Send current line to ellama chat.
@@ -256,7 +257,8 @@ File: ellama.info, Node: Commands, Next: Keymap, Prev:
Installation, Up: Top
buffer using Ellama.
• ‘ellama-summarize-killring’: Summarize text from the kill ring.
• ‘ellama-code-review’: Review code in a selected region or the
- current buffer using Ellama.
+ current buffer using Ellama. Automatically adds selected region or
+ current buffer to ephemeral context for one request.
• ‘ellama-change’: Change text in a selected region or the current
buffer according to a provided change.
• ‘ellama-make-list’: Create a markdown list from the active region
@@ -271,7 +273,7 @@ File: ellama.info, Node: Commands, Next: Keymap, Prev:
Installation, Up: Top
• ‘ellama-code-add’: Generate and insert new code based on
description. This function prompts the user to describe the code
they want to generate. If a region is active, it includes the
- selected text as context for code generation.
+ selected text in ephemeral context for code generation.
• ‘ellama-code-edit’: Change selected code or code in the current
buffer according to a provided change using Ellama.
• ‘ellama-code-improve’: Change selected code or code in the current
@@ -546,6 +548,10 @@ 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.
+Some commands add context automatically as ephemeral context:
+‘ellama-ask-about’, ‘ellama-code-review’, ‘ellama-write’, and
+‘ellama-code-add’.
+
* Menu:
* Transient Menus for Context Management::
@@ -1578,39 +1584,39 @@ Tag Table:
Node: Top1379
Node: Installation3748
Node: Commands8762
-Node: Keymap15839
-Node: Configuration18673
-Node: Context Management25874
-Node: Transient Menus for Context Management26782
-Node: Managing the Context28396
-Node: Considerations29171
-Node: Minor modes29764
-Node: ellama-context-header-line-mode31752
-Node: ellama-context-header-line-global-mode32577
-Node: ellama-context-mode-line-mode33297
-Node: ellama-context-mode-line-global-mode34145
-Node: Ellama Session Header Line Mode34849
-Node: Enabling and Disabling35418
-Node: Customization35865
-Node: Ellama Session Mode Line Mode36153
-Node: Enabling and Disabling (1)36738
-Node: Customization (1)37185
-Node: Using Blueprints37479
-Node: Key Components of Ellama Blueprints38119
-Node: Creating and Managing Blueprints38726
-Node: Blueprints files39704
-Node: Variable Management40125
-Node: Keymap and Mode40578
-Node: Transient Menus41514
-Node: Running Blueprints programmatically42060
-Node: MCP Integration42647
-Node: Agent Skills43669
-Node: Directory Structure44032
-Node: Creating a Skill45059
-Node: How it works45434
-Node: Acknowledgments45825
-Node: Contributions46536
-Node: GNU Free Documentation License46922
+Node: Keymap16049
+Node: Configuration18883
+Node: Context Management26084
+Node: Transient Menus for Context Management27152
+Node: Managing the Context28766
+Node: Considerations29541
+Node: Minor modes30134
+Node: ellama-context-header-line-mode32122
+Node: ellama-context-header-line-global-mode32947
+Node: ellama-context-mode-line-mode33667
+Node: ellama-context-mode-line-global-mode34515
+Node: Ellama Session Header Line Mode35219
+Node: Enabling and Disabling35788
+Node: Customization36235
+Node: Ellama Session Mode Line Mode36523
+Node: Enabling and Disabling (1)37108
+Node: Customization (1)37555
+Node: Using Blueprints37849
+Node: Key Components of Ellama Blueprints38489
+Node: Creating and Managing Blueprints39096
+Node: Blueprints files40074
+Node: Variable Management40495
+Node: Keymap and Mode40948
+Node: Transient Menus41884
+Node: Running Blueprints programmatically42430
+Node: MCP Integration43017
+Node: Agent Skills44039
+Node: Directory Structure44402
+Node: Creating a Skill45429
+Node: How it works45804
+Node: Acknowledgments46195
+Node: Contributions46906
+Node: GNU Free Documentation License47292
End Tag Table
