vuetifyjs/vuetify

[Documentation] Font Awesome preset comments

Open

#12,522 opened on Oct 28, 2020

View on GitHub
 (0 comments) (0 reactions) (1 assignee)TypeScript (7,139 forks)batch import
Service: IconsT: documentationT: enhancementgood first issue

Repository metrics

Stars
 (40,995 stars)
PR merge metrics
 (Avg merge 59d 10h) (8 merged PRs in 30d)

Description

Problem to solve

Clarity in icon usage for components, for delete and clear. Currently, it's confusing for people that use Font Awesome (5).

Proposed solution

Update comments in the fa.ts file, so it's more clear which components the icons are used in by default. Maybe include cancel and close too since those words all mean similar things.

image

Contributor guide

Research direction
Examine the fa.ts file and its comments, then add clear comments explaining which components use each icon, including cancel and close.
Tech stack
typescriptvue
Domain
frontenddocumentation
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90