docs(readme): link Exported API entries to Storybook doc pages - #15
Conversation
Replace plain API names in the Exported API section with links to the GitHub Pages Storybook doc pages (?path=/docs/<story-id>--api). - Components: 19 existing entries -> links, plus 6 missing HOC/context exports (ReactEasyContext, withConfirmAction, withDeleteConfirmAction, withModalAction, withDefaultConfirmActionProps, withDefaultModalActionProps) pointing at their owning component pages - Hooks: 15 existing entries -> links, plus missing useStreamDownloader - Utilities: 7 existing entries -> links, plus missing StreamDownloader - All 49 story ids verified against storybook-static/index.json
|
Warning Review limit reached
Next review available in: 48 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe README exported API listings now link components, hooks, and utilities to Storybook API documentation. The listings also include ChangesAPI documentation listings
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the README’s “Exported API” section to be a navigable index into the project’s GitHub Pages Storybook docs, while also filling in previously omitted public exports.
Changes:
- Convert all exported API entries (components/hooks/utils) from plain code-formatted names to Storybook doc links.
- Add missing public exports to the README index:
ReactEasyContextand severalwith*HOCs (components),useStreamDownloader(hooks), andStreamDownloader(utils). - Align link targets with the Storybook docs route pattern used by this repo (
?path=/docs/...--api).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Remove backticks from link text in Exported API section of README.md (49 links: [Name](url) instead of [`Name`](url)) - Apply the same linked Exported API list to README.zh-CN.md (导出能力), including the same 6 missing HOC/context components, useStreamDownloader and StreamDownloader additions - Both files verified with identical story ids against storybook-static/index.json (49 links, no dead links); prettier passes
Summary
Replace plain API names in the README "Exported API" section with links to the GitHub Pages Storybook doc pages, and fill in exports that were missing from the list.
Changes
ReactEasyContext,withConfirmAction,withDeleteConfirmAction,withModalAction,withDefaultConfirmActionProps,withDefaultModalActionProps(linked to their owning component pages, since HOCs/context share the component doc)useStreamDownloaderStreamDownloaderhttps://shijistar.github.io/react-easy/?path=/docs/<story-id>--apiVerification
storybook-static/index.json(built artifact) — none are missing, so no dead linkssrc/components,src/hooks,src/utilsindex files is now represented in the READMEprettier --check README.mdpassesSummary by CodeRabbit
ReactEasyContext, action helpers,useStreamDownloader, andStreamDownloader.