Skip to content

Commit 314546e

Browse files
committed
docs: Update README and todo
* README.md: Add note that directives are independent requests. * todo.org: Add planned changes for storing patches in overlay.
1 parent 624c191 commit 314546e

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ accurately.
7777
The video at the [beginning](#what-does-this-package-do) of this README should
7878
give you a good impression on the usage.
7979

80+
You can send your requests to the LLM either via the chat buffer (accessible by
81+
using `mevedel`) or by creating and submitting a directive.
82+
83+
**Please note:** Requests send from a directive **DO NOT** use the context of
84+
the chat buffer, only what is defined by the directive and its references.
85+
86+
8087
### Overlays
8188

8289
All instructions, references or directives, are highlighted in the buffer via an
@@ -85,7 +92,8 @@ overlay. The overlay contains an action menu which can be toggled via
8592

8693
![Directive Overlay](/.assets/images/ov-actions-menu.png)
8794

88-
A note for [evil](https://github.com/emacs-evil/evil) users:
95+
> [!NOTE]
96+
> A note for [evil](https://github.com/emacs-evil/evil) users:
8997
9098
If you want to customize the dispatch keybind such that it uses a key only in
9199
`normal-mode`, you will need to add something like this to your config:

todo.org

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,3 +64,11 @@
6464
* TODO Reference navigation based on a tag query
6565

6666
* TODO Tag autocompletion when writing directive tag query
67+
68+
* TODO Store patches in directive overlay
69+
When we have multiple directives and maybe even submitting them together, we
70+
should store the patch in the overlay, so the last modifications do not get lost
71+
for revisions.
72+
73+
Patch buffer should always contain the last modifications, no matter if from
74+
directive or directly from chat buffer.

0 commit comments

Comments
 (0)