cursorless icon indicating copy to clipboard operation
cursorless copied to clipboard

Restructure documentation to reflect new compositional modifiers

Open pokey opened this issue 3 years ago • 0 comments

We'd like to restructure out documentation to more accurately reflect Cursorless's new internal representation. We should have sections for:

  • Scope types
  • Modifiers
  • Actions

They can link to each other. So for example the "containing scope" modifier can link to list of scope types

  • [ ] Also discuss frontmatter thing for auto-generating docs

Scope types should include:

  • [ ] Languages supported
  • [ ] Examples from different languages
  • [ ] Iteration scope
  • [ ] Domain
  • [ ] Removal range
  • [ ] Content range

Could include info from test cases as per #866?

See also some (very rough 😅) images from a brainstorming session:

IMG_8536 IMG_8535 IMG_8534 IMG_8539 IMG_8538 IMG_8537

pokey avatar Jul 14 '22 16:07 pokey