OpenParable
Skip to content
← Back to skills

Guide

Business
guide

Guide is an Agent Skill for business published in the recharts/recharts repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Create new article guides for Recharts users

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/recharts/recharts/blob/HEAD/.agents/skills/guide/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/guide, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

What is a guide?

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.

Guide structure

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.

Creating a new guide

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 itself
  • www/src/views/GuideView.tsx - import and add the guide to the list of guides
  • www/src/navigation.data.ts - add the guide to the navigation data for it to be visible in the sidebar
  • www/src/locale/en-US.ts - add the guide title in english
  • www/src/locale/zh-CN.ts - add the guide title in chinese

All of these must be defined, otherwise the guide will not show up in the navigation.