From 30fd2e83ece43bf189fb8a506d34f2924467be6f Mon Sep 17 00:00:00 2001 From: Andreas Arvidsson Date: Wed, 2 Sep 2026 11:09:36 +0200 Subject: [PATCH] Added documentation for learning resources. --- CHANGELOG.md | 1 + .../app-web-docs/sidebarItemsGenerator.ts | 2 +- packages/app-web-docs/src/docs/user/README.md | 2 +- .../src/docs/user/learning-resources.md | 28 +++++++++++++++++++ .../src/docs/user/scope-sidebar.md | 26 ++++++++++++++++- 5 files changed, 56 insertions(+), 3 deletions(-) create mode 100644 packages/app-web-docs/src/docs/user/learning-resources.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 78e8fc0016..957bf88d51 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## 2026 +- 2026-09-02: Added documentation for learning resources. ([#3334](https://github.com/cursorless-dev/cursorless/pull/3334)) - 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)) diff --git a/packages/app-web-docs/sidebarItemsGenerator.ts b/packages/app-web-docs/sidebarItemsGenerator.ts index 1f948f658e..0b6f71dd44 100644 --- a/packages/app-web-docs/sidebarItemsGenerator.ts +++ b/packages/app-web-docs/sidebarItemsGenerator.ts @@ -12,7 +12,7 @@ const items: (Group | string)[] = [ "Cursorless", { label: "Getting started", - items: ["Installation", "How-to guides"], + items: ["Installation", "Learning resources", "How-to guides"], }, { label: "Reference", diff --git a/packages/app-web-docs/src/docs/user/README.md b/packages/app-web-docs/src/docs/user/README.md index 99dbb49563..b307112c66 100644 --- a/packages/app-web-docs/src/docs/user/README.md +++ b/packages/app-web-docs/src/docs/user/README.md @@ -4,7 +4,7 @@ slug: / # Cursorless -Welcome to Cursorless! If you're new, start with the [tutorial videos](https://www.youtube.com/watch?v=5mAzHGM2M0k&list=PLXv2sppxeoQZz49evjy4T0QJRIgc_JPqs) or the [how-to guides](./how-to.md). +Welcome to Cursorless! If you're new, start with the [learning resources](./learning-resources.md) or the [how-to guides](./how-to.md). This guide assumes you've already [installed Cursorless](./installation.md). diff --git a/packages/app-web-docs/src/docs/user/learning-resources.md b/packages/app-web-docs/src/docs/user/learning-resources.md new file mode 100644 index 0000000000..91a21e67ec --- /dev/null +++ b/packages/app-web-docs/src/docs/user/learning-resources.md @@ -0,0 +1,28 @@ +# Learning resources + +These resources can help you learn Cursorless, from your first commands through more advanced workflows. + +## Start here + +- [Cursorless tutorial videos](https://www.youtube.com/watch?v=5mAzHGM2M0k&list=PLXv2sppxeoQZz49evjy4T0QJRIgc_JPqs) - Learn the basic concepts and commands. +- [Interactive tutorial](./scope-sidebar.md#tutorial) - Learn Cursorless inside your editor using the Cursorless sidebar. + +## Learn from examples + +- [Cursorless by example](https://www.youtube.com/watch?v=2hPwfBCtXws&list=PLbN8ceamGu2c6JrNf83EWyP6K5K77MzVZ) - Watch Cursorless applied to practical editing tasks. +- [Cursorless: A spoken language for editing code](https://youtu.be/NcUJnmBqHTY) - Learn the ideas behind Cursorless in this Strange Loop talk. +- [Pokey's Cursorless videos](https://www.youtube.com/@PokeyRuleJams) - See demonstrations of Cursorless features and workflows. +- [Andreas's Cursorless videos](https://www.youtube.com/@andreas_arvidsson) - See demonstrations of Cursorless and Talon features. + +## Practice and reference + +- [Cursorless cheatsheet](https://www.cursorless.org/cheatsheet) - Look up actions, scopes, modifiers, and other spoken forms. +- [Scope visualizer](./scope-visualizer.md) - Explore which Cursorless scopes are available in your code. + +## Talon and community resources + +- [Talon documentation](https://talonvoice.com/docs) - Learn about Talon concepts and APIs from the official documentation. +- [Talon Community Wiki](https://talon.wiki) - Find community-maintained guides, integrations, and customization resources. +- [Talon Slack](https://talonvoice.com/chat) - Ask questions and connect with the Talon community. +- [Talon Search](https://search.talonvoice.com) - Search Talon Community and other users' GitHub repositories for Talon scripts. +- [Cursorless GitHub Discussions](https://github.com/cursorless-dev/cursorless/discussions) - Ask questions and discuss Cursorless ideas and workflows. diff --git a/packages/app-web-docs/src/docs/user/scope-sidebar.md b/packages/app-web-docs/src/docs/user/scope-sidebar.md index f134c9e932..bc9bfd963b 100644 --- a/packages/app-web-docs/src/docs/user/scope-sidebar.md +++ b/packages/app-web-docs/src/docs/user/scope-sidebar.md @@ -22,4 +22,28 @@ To identify the scope for a piece of code: ## Tutorial -Interactive tutorial to learn Cursorless +The sidebar includes interactive tutorials that teach Cursorless using guided exercises in a practice document: + +- **Introduction** covers selecting tokens and ranges, using multiple targets, working with lines, deleting text, and positioning the cursor. +- **Basic coding** covers structural scopes and actions such as clone, swap, pour, bring, and dedent. + +Each step shows a command to say and usually advances automatically when you complete it. The tutorial uses your custom spoken forms and saves your progress so that you can continue where you left off. + +### Start a tutorial + +With VSCode focused, say `"cursorless tutorial"` to start or continue the Introduction tutorial. + +To choose a tutorial, say `"tutorial list"`, then click its name or say `"tutorial "`. For example, say `"tutorial two"` to start or continue Basic coding. + +You can also say `"bar cursorless"` and choose a tutorial from the Tutorial section of the sidebar. + +### Navigate the tutorial + +You can use the arrow buttons in the sidebar or these commands: + +- `"tutorial next"` - Move to the next step. +- `"tutorial previous"` or `"tutorial last"` - Move to the previous step. +- `"tutorial restart"` - Return to the first step of the current tutorial. +- `"tutorial list"` or `"tutorial close"` - Return to the tutorial list. + +The tutorial opens a practice document and expects it to match the current exercise. If you edit the document or move away from it, say `"tutorial resume"` to restore the current step and continue.