Skip to content
This repository was archived by the owner on May 11, 2022. It is now read-only.

Hintbox work in progress #449

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

bfitzpat
Copy link
Collaborator

@bfitzpat bfitzpat commented Mar 3, 2021

This came out of the idea that was mentioned at the Fuse Sync Call for an easy way to bubble up some of the buried functionality of VS Code such as useful settings (like the Runtime switch @apupier mentioned) or commands.

didact-hintbox-demo

Definitely a work in progress, but the high-level idea is that we would have a simple webview in the view side that could possibly change based on content of a particular editor that's open. Not much room, so would limit to maybe the top 5 useful tips or settings that would apply to a particular context.

For instance, if I create one of these for editing Didact files (which is likely), it would be a simple list that would appear if you have a Markdown or AsciiDoc file open in an editor:

  • Use Ctrl (or Cmd)+Alt+V to preview your file in the Didact preview window

Signed-off-by: Brian Fitzpatrick bfitzpat@redhat.com

@bfitzpat bfitzpat added the work in progress A draft PR or work in progress label Mar 3, 2021
@bfitzpat bfitzpat self-assigned this Mar 3, 2021
@bfitzpat
Copy link
Collaborator Author

bfitzpat commented Mar 3, 2021

This demo just shows how it might appear to the user with a static Didact page and a couple of options, but to push forward I would:

  • Refactor the code to avoid so much duplication between DidactPanel and HintBoxViewProvider
  • Provide a simple example for Didact file editing (adoc/md) as described in my initial comment
  • Explore how best to change the activation events to support files from other extensions (such as Camel K or AtlasMap) so that these bite-sized hint didact tutorials would be easy to produce and package with other projects
  • Add better documentation about how to define one of these, with guidelines on avoiding lengthy views (though scrollbars do work)

@bfitzpat
Copy link
Collaborator Author

bfitzpat commented Mar 3, 2021

(Note that the failing windows test should be fixed by the work done in #448 when it gets approved and merged.)

bfitzpat added 2 commits March 4, 2021 09:52
Signed-off-by: Brian Fitzpatrick <bfitzpat@redhat.com>
Signed-off-by: Brian Fitzpatrick <bfitzpat@redhat.com>
@bfitzpat
Copy link
Collaborator Author

Leaving this open for now to explore other options like the new welcome screen in VS Code that we may be able to leverage.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
work in progress A draft PR or work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant