Skip to content

Conversation

@Poylar
Copy link

@Poylar Poylar commented Nov 25, 2025

Update wrong import path

Summary by CodeRabbit

  • Documentation
    • Updated import path example in the React package README to reflect current package naming conventions.

✏️ Tip: You can customize this high-level summary in your review settings.

Update wrong import path
@vercel
Copy link

vercel bot commented Nov 25, 2025

@Poylar is attempting to deploy a commit to the shipshapecode Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link

coderabbitai bot commented Nov 25, 2025

Walkthrough

The README documentation in the React package is updated to correct the import path example from @shepherdpro/react to react-shepherd, reflecting the current package name used by consumers.

Changes

Cohort / File(s) Change Summary
Documentation
packages/react/README.md
Updated import path example from @shepherdpro/react to react-shepherd

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single-line documentation correction with no logic impact

Poem

🐰 A path through the docs, now straight and true,
From old names to new, we'll guide you through.
React-shepherd leads the way,
Hop along—let's code today! 🌟

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly and specifically describes the main change: updating an example path in the README documentation.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
packages/react/README.md (1)

3-3: Consider updating package references for consistency.

The README now has conflicting package references:

  • Line 3: NPM badge references @shepherdpro/react
  • Line 5: GitHub link references @shepherdpro/react
  • Lines 14 & 23: Install and import examples reference react-shepherd

Additionally, the GitHub URL format on line 5 appears malformed (GitHub paths typically don't include @ in the URL path).

While outside the immediate scope of this PR, updating these references to use the correct package name and valid repository URL would improve documentation consistency and prevent user confusion.

Could you verify the correct NPM package name and GitHub repository URL, and confirm whether these should be updated as part of this PR?

Also applies to: 5-5

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db2c1e6 and 51247da.

📒 Files selected for processing (1)
  • packages/react/README.md (1 hunks)
🔇 Additional comments (1)
packages/react/README.md (1)

23-23: Import statement correctly updated.

The import now matches the package name shown in the install command (react-shepherd), resolving the inconsistency.

@Poylar Poylar changed the title Update README.md Update README example path Nov 26, 2025
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.

1 participant