Skip to content

docs(readme): link Exported API entries to Storybook doc pages - #15

Merged
shijistar merged 2 commits into
masterfrom
feature/readme-api-links
Aug 8, 2026
Merged

docs(readme): link Exported API entries to Storybook doc pages#15
shijistar merged 2 commits into
masterfrom
feature/readme-api-links

Conversation

@shijistar

@shijistar shijistar commented Aug 8, 2026

Copy link
Copy Markdown
Owner

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

  • Components (19 → 25): all existing entries are now links to their Storybook API pages; added 6 missing exports that were omitted:
    • ReactEasyContext, withConfirmAction, withDeleteConfirmAction, withModalAction, withDefaultConfirmActionProps, withDefaultModalActionProps (linked to their owning component pages, since HOCs/context share the component doc)
  • Hooks (15 → 16): all existing entries are now links; added missing useStreamDownloader
  • Utilities (7 → 8): all existing entries are now links; added missing StreamDownloader
  • Link format follows the existing pattern: https://shijistar.github.io/react-easy/?path=/docs/<story-id>--api

Verification

  • All 49 story ids in the README were cross-checked against storybook-static/index.json (built artifact) — none are missing, so no dead links
  • Every public export from src/components, src/hooks, src/utils index files is now represented in the README
  • prettier --check README.md passes
  • GitHub Pages site reachable (HTTP 200)

Summary by CodeRabbit

  • Documentation
    • Updated API listings with links to the corresponding Storybook documentation pages.
    • Added documentation entries for ReactEasyContext, action helpers, useStreamDownloader, and StreamDownloader.

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
Copilot AI lite review requested due to automatic review settings August 8, 2026 14:14
@coderabbitai

coderabbitai Bot commented Aug 8, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@shijistar, you've reached your PR review limit, so we couldn't start this review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: afa71b91-5369-44b3-bc56-105b3f675d5f

📥 Commits

Reviewing files that changed from the base of the PR and between d644d5f and 3b1f638.

📒 Files selected for processing (2)
  • README.md
  • README.zh-CN.md
📝 Walkthrough

Walkthrough

The README exported API listings now link components, hooks, and utilities to Storybook API documentation. The listings also include ReactEasyContext, action helpers, useStreamDownloader, and StreamDownloader.

Changes

API documentation listings

Layer / File(s) Summary
Update exported API listings
README.md
API names now link to Storybook documentation. The listings include the added components, action helpers, hook, and utility.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main README change: linking exported API entries to Storybook documentation pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/readme-api-links

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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: ReactEasyContext and several with* HOCs (components), useStreamDownloader (hooks), and StreamDownloader (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
@shijistar
shijistar merged commit 7960f66 into master Aug 8, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants