redhat-developer/vscode-yaml

Move documentation from the wiki to a documentation folder of the repo

Open

#452 opened on Mar 16, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (259 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (820 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your enhancement related to a problem? Please describe.

To make the documentation more visible we should move the documentation from the wiki into somewhere that's more discoverable.

Describe the solution you would like

We move the documentation into /documentation

Describe alternatives you have considered

Start linking the wiki in the readme so that more extension developers are redirected there

Additional context

Contributor guide

Research direction
Move the wiki pages into a new or existing /documentation directory in the repository. Ensure all links and references are updated.
Tech stack
typescript
Domain
documentation
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.
Under 1 hour
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.
Clear
Prerequisites
Gitbasic understanding of the repo structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85