Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create guides and best practices for extension authors #126

Closed
daviddossett opened this issue Jun 4, 2021 · 1 comment · Fixed by #322
Closed

Create guides and best practices for extension authors #126

daviddossett opened this issue Jun 4, 2021 · 1 comment · Fixed by #322
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@daviddossett
Copy link
Collaborator

Feature/component description

Lets ensure extension authors have great docs, walkthroughs, and/or other resources to help them build webview extensions that look and feel native to VS Code. This could take the form of Figma files, videos, docs, sample extensions, and more!

@daviddossett daviddossett added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 4, 2021
@daviddossett daviddossett added this to the Public Beta milestone Jun 4, 2021
@hawkticehurst hawkticehurst modified the milestones: Public Beta, v1.0 Sep 16, 2021
@hawkticehurst hawkticehurst modified the milestones: General Availability (v1.0), Backlog Dec 9, 2021
@daviddossett daviddossett modified the milestones: Backlog, January 2022 Jan 11, 2022
@daviddossett
Copy link
Collaborator Author

daviddossett commented Jan 14, 2022

Some early thoughts on how we could improve the experience of developing webviews (taken from offline brainstorm w/ @hawkticehurst and @misolori)

Hypotheses

  • There are limited design guidelines and samples that showcase best practices and inspiration for extensions using webviews
  • The cat coding guide feels intimidating as a first introduction to webviews. It also feels unrelated to a real UI.
  • Developers aren’t aware that they can leverage a UI toolkit in their webviews

How could we help provide design guidance?

  • More detailed higher-level patterns (sidebar, editor, both, etc.)
  • Component-level documentation (do/don't, usage, examples)
  • Clearly illustrate common API capabilities we see often duplicated (e.g. TreeView)
  • ...

How could we improve the dev docs?

  • Simplify the core VS Code webview API docs and explain concepts for less experienced developers (e.g. disposing)
  • Brief summary of toolkit usage in core VS Code docs w/ link to a detailed walkthrough in the toolkit repo
  • Add hello world starter templates for extension authors to clone in various permutations (vanilla js, frameworks, build systems)
  • Add generalized guidelines for frameworks in toolkit docs

More to come 🤘

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants