Skip to content

Restructure documentation to reflect new compositional modifiers #867

@pokey

Description

@pokey

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions