Skip to content

Add ability to highlight newly released features in a webview #491

@pokey

Description

@pokey

The problem

There is currently no way for a user to know when we release new features in cursorless. We'd like some way to highlight new features for users.

The solution

We'd like to display release notes in a webview when we release new features. We don't want to do so on every release, especially once we move to continuous delivery (#17), but we should have some mechanism to highlight new features when we want to. We could do something roughly as follows

  • Have a directory of markdown files, one per each feature that we want to highlight
  • Keep track of which feature highlights the user has seen using global storage, making sure to sync across instances
  • Stitch together the highlights they haven't seen and show them in a webview on extension update
  • Figure out a way to include these feature highlight snippets in the docs?
  • Can use these to link to video showing how to use the feature
  • Do this monthly?
  • Also publish this to the website
  • Do this automatically from PRs using some automated system? Maybe https://github.com/uptech/git-cl

update

  • Have release notes just in docs site
  • Show a toast in vscode that links to page
  • Each release has its own file eg 0.27.0.md. Can have frontmatter with release date for future use
  • When extension starts, look for version key. If it does exist, check if it's less than current version. If it is, show a toast linking to current version. Then set the key to current version either way
    • Make sure that the key is synced so it doesn't show on their other computers
  • Show sponsor link
  • In the future we can automatically generate release notes from smaller markdown files that each PR contributes with the feature it introduces, including frontmatter about how major it is, date, etc
  • Make sure release notes unroll when linked in slack
  • post them to slack when I release them

Resources

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationhelp wantedExtra attention is needed

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions