| name | guide |
| description | Create new article guides for Recharts users |
Guide is an article explaining a certain topic related to Recharts. It can be a tutorial, a best practices article, or an in-depth explanation of a specific feature.
Guides are JSX components defined in www/src/components/GuideView folder.
Each guide is a folder. Inside the folder there is index.tsx file which is the main component of the guide.
A guide will usually contain one or more example charts which will be in their own files in the same folder. These charts are imported and used in the main index.tsx file.
Look at the website-example skill for instructions on how to create example charts.
When creating a new guide, the exported component must be registered in few places for it to be visible in the UI:
www/src/components/GuideView/<guideName>/index.tsx - the guide component itselfwww/src/views/GuideView.tsx - import and add the guide to the list of guideswww/src/navigation.data.ts - add the guide to the navigation data for it to be visible in the sidebarwww/src/locale/en-US.ts - add the guide title in englishwww/src/locale/zh-CN.ts - add the guide title in chineseAll of these must be defined, otherwise the guide will not show up in the navigation.
Write strongly-typed TypeScript code in Recharts
Find root cause for a bug or an issue in Recharts and propose a solution
Create new example charts for Recharts documentation website
Create visual regression tests
