wpilibsuite/vscode-wpilib

Update Help Page

Open

#24 opened on May 25, 2018

View on GitHub
 (2 comments) (0 reactions) (0 assignees)TypeScript (121 stars) (63 forks)auto 404
good first issuehelp wanted

Description

We have a help page located at https://github.com/wpilibsuite/vscode-wpilib/blob/master/vscode-wpilib/resources/help.html

Currently it doesn't really have anything other then an image. Scripts and css are not currently enabled, but they can be. Any resources need to be placed in the resources folder, and then accessed with replaceresource/ as the root path. See the current code for an example of how this works.

Contributor guide

Tech stack
typescript
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
GitHTMLCSSJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the existing help.html and understand the resource serving mechanism using 'replaceresource/' path. Look at example in codebase for how to include scripts and CSS.