redhat-developer / redhat-developer/vscode-wizard

Docs for UI widgets

Open
#84 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
10
Forks
10
PR merge metrics
No merged PRs in 30d

Description

To give an overview of vscode-wieard, I think it should be nice to show some screenshot of UI:

  • wizard with buttons, etc
  • for each UI widgets a piece of code (on the left) and a screenshot of the UI renderer.

Those pages could be hosted in https://github.com/redhat-developer/vscode-wizard/docs folder (eg : https://github.com/redhat-developer/vscode-xml/tree/master/docs)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the repository's docs folder and the linked vscode-xml docs example to understand the expected structure. Identify the wizard and UI widgets exposed by vscode-wizard, then document each with a code example and renderer screenshot, including an overview page. Done means the docs cover the requested wizard and widget examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.