Charts: Separate API reference docs from usage docs

[adamwoodnz]

Fixes CHARTS-124: Separate API Reference docs

Proposed changes:

• Separates the API reference documentation for each chart from the usage documentation, into a new API Reference storybook documentation entry
• Moves the existing API Reference section in each main Docs entry up to immediately below the Overview, for easy discovery
• Updates the AI guidelines for documentation to create the separate docs, updates the existing docs template, and adds a new template for the API reference

Screenshots

Main Docs	API Reference

Other information:

• Have you written new tests for your changes, if applicable?
• Have you checked the E2E test CI results, and verified that your changes do not break them?
• Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

Does this pull request change what data or activity we track or use?

Testing instructions:

• Go to http://localhost:50240/?path=/docs/js-packages-charts-types-bar-chart--docs
• Check the main Docs has no API reference details, and instead has a section immediately below the Overview that links to http://localhost:50240/?path=/docs/js-packages-charts-types-bar-chart-api-reference--docs
• Review the new API reference against the existing at https://automattic.github.io/jetpack-storybook/?path=/docs/js-packages-charts-types-bar-chart--docs#api-reference. There should be no significant changes, although it's possible the AI might have updated details it found to be incorrect. I haven't observed this though.
• Repeat this for the other charts
• Check that the Line Chart annotation API reference has been included in the main Line Chart API reference, and the Donut Chart API reference links to the Pie Chart API reference

[github-actions]

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

• To test on WoA, go to the Plugins menu on a WoA dev site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin (Jetpack), and enable the charts-124-separate-api-reference-docs branch.
• To test on Simple, run the following command on your sandbox:

bin/jetpack-downloader test jetpack charts-124-separate-api-reference-docs

Interested in more tips and information?

• In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
• Read more about our development workflow here: PCYsg-eg0-p2
• Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

[github-actions]

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

• ✅ Include a description of your PR changes.
  
• ✅ Add a "[Status]" label (In Progress, Needs Review, ...).
  
• ✅ Add a "[Type]" label (Bug, Enhancement, Janitorial, Task).
  
• ✅ Add testing instructions.
  
• ✅ Specify whether this PR includes any changes to data or privacy.
  
• ✅ Add changelog entries to affected projects
  

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

---

Follow this PR Review Process:

1. Ensure all required checks appearing at the bottom of this PR are passing.
2. Make sure to test your changes on all platforms that it applies to. You're responsible for the quality of the code you ship.
3. You can use GitHub's Reviewers functionality to request a review.
4. When it's reviewed and merged, you will be pinged in Slack to deploy the changes to WordPress.com simple once the build is done.

If you have questions about anything, reach out in #jetpack-developers for guidance!

[jp-launch-control]

Code Coverage Summary

This PR did not change code coverage!

That could be good or bad, depending on the situation. Everything covered before, and still is? Great! Nothing was covered before? Not so great. 🤷

Full summary · PHP report · JS report

[Copilot]

Pull Request Overview

This PR separates API reference documentation from usage documentation across all chart components in the Charts package. The separation creates dedicated API reference pages while maintaining usage-focused main documentation.

• Extracts comprehensive API documentation into separate Storybook entries
• Updates main docs to focus on usage patterns with cross-references to API documentation
• Creates new documentation templates and updates AI guidelines for future consistency

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Chart component .docs.mdx files	Remove API reference sections, add links to separate API docs
Chart component .api.mdx files	New dedicated API reference documentation
Documentation templates	New API template and updated main template structure
AI documentation guide	Updated guidelines for creating separate API reference docs
Changelog	Documents the separation of API reference documentation

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[kangzj]

LGTM! Nice improvement 👍