vuejs/devtools

Improve documentation on devtools usage

Open

#547 opened on Jul 25, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (24,286 stars) (4,095 forks)batch import
documentationgood first issuepr welcome

Description

Our docs lack many usage descriptions, like shortcut lists, feature detailed descriptions, and others.

Related #406 #546 #545 #404 #245

Contributor guide

Tech stack
vuetypescript
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic knowledge of Vue Devtools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Review the current documentation for the Vue Devtools to identify sections that lack usage descriptions, such as shortcut lists and feature details. Examine the related issues #406, #546, #545, #404, #245 for specific missing content. Then, create a pull request that adds the missing documentation, ensuring it covers the identified gaps.