ionic-team/ionicons

Improve documentation on how to use Ionicons

Open

#1.448 geöffnet am 16. Apr. 2025

Auf GitHub ansehen
 (4 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)TypeScript (17.256 Stars) (2.083 Forks)batch import
help wanted

Beschreibung

Current Behavior

Going through the issues I've seen the following theme that mostly indicates a lack of documentation on how to use Ionicons properly:

Expected Behavior

Update the documentation to respect modern stacks and tools. Make changes in necessary to improve the DX.

Steps to Reproduce

n/a

Code Reproduction URL

No response

Additional Information

No response

Contributor Guide

Tech Stack
typescriptjavascriptreactvueangularstorybook
Domain
documentationdeveloper experience
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
3-5 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
active
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScript fundamentalsDocumentation writing experienceFamiliarity with Ionicons
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65
Research-Richtung
Start by reviewing all linked issues (e.g., #877, #1340, #1435) to understand the specific documentation gaps. Then examine the current README.md and any docs/ folder in the repository to identify where to add sections. For each integration (Angular, React, Vue, esbuild, SSR, Storybook), create or update usage guides with clear examples. Consider reaching out to maintainers in the issue comments to confirm the preferred documentation structure and style.