ionic-team/ionicons

Improve documentation on how to use Ionicons

Open

#1448 opened on Apr 16, 2025

View on GitHub
 (4 comments) (3 reactions) (0 assignees)TypeScript (17,256 stars) (2,083 forks)batch import
help wanted

Description

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
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
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
JavaScript fundamentalsDocumentation writing experienceFamiliarity with Ionicons
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
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.