Skip to content

Commit ff28e23

Browse files
Added documentation for the Talon community draft editor (#3333)
Fixes #916
1 parent c36205d commit ff28e23

3 files changed

Lines changed: 26 additions & 1 deletion

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## 2026
44

5+
- 2026-09-02: Added reference documentation for community draft editor. ([#3333](https://github.com/cursorless-dev/cursorless/pull/3333))
6+
- 2026-09-02: Added reference documentation for community alphabet and symbols. ([#3332](https://github.com/cursorless-dev/cursorless/pull/3332))
57
- 2026-09-02: Visualize actions on the documentation page. ([#3330](https://github.com/cursorless-dev/cursorless/pull/3330))
68
- 2026-09-01: Visualize modifiers on the documentation page. ([#3328](https://github.com/cursorless-dev/cursorless/pull/3328); [#3329](https://github.com/cursorless-dev/cursorless/pull/3329))
79
- 2026-08-30: Overhauled the user documentation with generated and grouped action, modifier, and scope reference pages, richer descriptions and examples, dedicated paired-delimiter and target guides, and a streamlined landing page. ([#3303](https://github.com/cursorless-dev/cursorless/pull/3303); [#3304](https://github.com/cursorless-dev/cursorless/pull/3304); [#3305](https://github.com/cursorless-dev/cursorless/pull/3305); [#3306](https://github.com/cursorless-dev/cursorless/pull/3306); [#3307](https://github.com/cursorless-dev/cursorless/pull/3307); [#3308](https://github.com/cursorless-dev/cursorless/pull/3308); [#3309](https://github.com/cursorless-dev/cursorless/pull/3309); [#3310](https://github.com/cursorless-dev/cursorless/pull/3310); [#3311](https://github.com/cursorless-dev/cursorless/pull/3311); [#3312](https://github.com/cursorless-dev/cursorless/pull/3312); [#3313](https://github.com/cursorless-dev/cursorless/pull/3313); [#3314](https://github.com/cursorless-dev/cursorless/pull/3314); [#3315](https://github.com/cursorless-dev/cursorless/pull/3315); [#3316](https://github.com/cursorless-dev/cursorless/pull/3316))

‎packages/app-web-docs/sidebarItemsGenerator.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,12 @@ const items: (Group | string)[] = [
3333
},
3434
{
3535
label: "Tools",
36-
items: ["Cursorless sidebar", "Scope visualizer", "Local command history"],
36+
items: [
37+
"Cursorless sidebar",
38+
"Scope visualizer",
39+
"Local command history",
40+
"Draft editor",
41+
],
3742
},
3843
{
3944
label: "Advanced",
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Draft editor
2+
3+
The draft editor is a [Talon Community](https://github.com/talonhub/community) plugin that lets you revise text in a full text editor before inserting it
4+
back into the application where you started. It is useful for composing longer
5+
messages in applications whose text fields have limited editing or voice-control
6+
support.
7+
8+
The plugin uses an already-running editor application. It opens a new tab in
9+
that editor, optionally copies selected text into it, and remembers the original
10+
window. When you submit the draft, the plugin closes the temporary tab, returns
11+
to the original window, and pastes the revised text. If text was selected in the
12+
original window, the paste replaces that selection.
13+
14+
For setup, available commands, and configuration details, see the [Talon Community draft editor plugin](https://github.com/talonhub/community/tree/main/plugin/draft_editor).
15+
16+
## Demo
17+
18+
[Watch the draft editor demo on YouTube](https://www.youtube.com/watch?v=U6Q9qjSIVQg).

0 commit comments

Comments
 (0)