diff --git a/CHANGELOG.md b/CHANGELOG.md index 4e4359b36d..78e8fc0016 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,8 @@ ## 2026 +- 2026-09-02: Added reference documentation for community draft editor. ([#3333](https://github.com/cursorless-dev/cursorless/pull/3333)) +- 2026-09-02: Added reference documentation for community alphabet and symbols. ([#3332](https://github.com/cursorless-dev/cursorless/pull/3332)) - 2026-09-02: Visualize actions on the documentation page. ([#3330](https://github.com/cursorless-dev/cursorless/pull/3330)) - 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)) - 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)) diff --git a/packages/app-web-docs/sidebarItemsGenerator.ts b/packages/app-web-docs/sidebarItemsGenerator.ts index 6635f0ce23..1f948f658e 100644 --- a/packages/app-web-docs/sidebarItemsGenerator.ts +++ b/packages/app-web-docs/sidebarItemsGenerator.ts @@ -33,7 +33,12 @@ const items: (Group | string)[] = [ }, { label: "Tools", - items: ["Cursorless sidebar", "Scope visualizer", "Local command history"], + items: [ + "Cursorless sidebar", + "Scope visualizer", + "Local command history", + "Draft editor", + ], }, { label: "Advanced", diff --git a/packages/app-web-docs/src/docs/user/draft-editor.md b/packages/app-web-docs/src/docs/user/draft-editor.md new file mode 100644 index 0000000000..33ff98d9db --- /dev/null +++ b/packages/app-web-docs/src/docs/user/draft-editor.md @@ -0,0 +1,18 @@ +# Draft editor + +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 +back into the application where you started. It is useful for composing longer +messages in applications whose text fields have limited editing or voice-control +support. + +The plugin uses an already-running editor application. It opens a new tab in +that editor, optionally copies selected text into it, and remembers the original +window. When you submit the draft, the plugin closes the temporary tab, returns +to the original window, and pastes the revised text. If text was selected in the +original window, the paste replaces that selection. + +For setup, available commands, and configuration details, see the [Talon Community draft editor plugin](https://github.com/talonhub/community/tree/main/plugin/draft_editor). + +## Demo + +[Watch the draft editor demo on YouTube](https://www.youtube.com/watch?v=U6Q9qjSIVQg).