Description
This doc page covers how a new user to Positron would find and interact with the Command Palette. We think that the Command Palette should be a top level item that shows up in the sidebar due its importance to a user's workflow.
Outline
Below is the proposed outline for the section.
Role of the Command Palette
Mention the keyboard shortcut to the command palette with a screenshot. That is the most important thing a user needs to know to get going.
We should talk about the importance of the command palette to a user's workflow. This section of the doc should encourage (RStudio) users to lean on the command palette for buttons/panes/menus they feel are missing. If there's something you don't see in the UI - there's probably a command for it that can be run via the command palette.
We can link out to the VS Code docs on the Command Palette here: https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette
Commands
This section should contain a comprehensive list of all commands.
The table can be split into commands for the following categories:
- Positron Core Commands
- Python Extension
- R Extension
Power User
Talk about commands having IDs and how you can configure a keybinding for the command. Link out to keybindings doc.
Questions
Do we guarantee that the table of commands is always up-to-date? From a developer perspective we need to consider how we will keep this list up to date. Some sort of automation around this feels necessary. During a release build we generate a command list table for the doc as an artifact.
Can we filter through the command registry to output all the positron commands with a description? This could be part of the dev build process.
This regex will show all files with positron and registerCommand together in VS Code: (registerCommand\()(?=[\s\S]*positron|[\s\S]*?positron[\s\S]*?registerCommand\()