ionic-team / ionic-team/ionicons
Improve documentation on how to use Ionicons
- Lenguaje dominante
- TypeScript
- Estrellas
- 18.2k
- Forks
- 2.1k
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
### 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:
- https://github.com/ionic-team/ionicons/issues/877
- differentiate between lazy build and custom element, maybe remove lazy all together, refs #1441
- document how to integrate into Angular #1340
- document how to integrate into Reach https://github.com/ionic-team/ionicons/issues/835
- document how to integrate into Vue https://github.com/ionic-team/ionicons/issues/1043
- document how to integate when using esbuild #1435
- integration into [storybook](https://github.com/ionic-team/ionicons/issues/670)
- bundling icons for offline use [#821](https://github.com/ionic-team/ionicons/issues/821)
- Using with a bundle https://github.com/ionic-team/ionicons/issues/1133, https://github.com/ionic-team/ionicons/issues/648, https://github.com/ionic-team/ionicons/issues/774, https://github.com/ionic-team/ionicons/issues/751
- document how to enable SSR support (https://github.com/ionic-team/ionicons/issues/1404, https://github.com/ionic-team/ionicons/issues/886)
- usage of custom icons https://github.com/ionic-team/ionicons/issues/535, https://github.com/ionic-team/ionicons/issues/1013, https://github.com/ionic-team/ionicons/issues/589
### 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_
Guía de contribución
Línea de trabajo
Revisa la documentación existente de Ionicons y las issues enlazadas sobre Angular, bundling, Storybook, SSR, uso sin conexión e iconos personalizados. Define un plan de documentación centrado para las integraciones cubiertas y verifica después que cada caso de uso enumerado tenga instrucciones claras de configuración y ejemplos para stacks modernos.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- angular, storybook, typescript
- Área
- developer-experience, documentation, web-dev
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100