Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Next JS SDK - Update readme.md #194

Merged
merged 1 commit into from
Jul 28, 2024
Merged

Next JS SDK - Update readme.md #194

merged 1 commit into from
Jul 28, 2024

Conversation

clairekinde11
Copy link
Contributor

Fixed an incorrect link that was pointing to Notion and not the docs site.

Explain your changes

Suppose there is a related issue with enough detail for a reviewer to understand your changes fully. In that case, you can omit an explanation and instead include either “Fixes #XX” or “Updates #XX” where “XX” is the issue number.

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Fixed an incorrect link
Copy link
Contributor

coderabbitai bot commented Jul 22, 2024

Walkthrough

The recent modification primarily updates the readme.md file to replace an outdated hyperlink with a direct link to the official Kinde NextJS SDK documentation. This change aims to improve user experience by providing clearer and more reliable access to essential SDK information, ensuring users can easily navigate to the necessary resources without confusion.

Changes

Files Change Summary
readme.md Updated hyperlink to Kinde NextJS SDK documentation, replacing the old Notion link for better clarity and accessibility.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@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

Outside diff range, codebase verification and nitpick comments (1)
readme.md (1)

Line range hint 1-11:
Update spelling to "Next.js".

The official spelling of this framework is "Next.js". Consider updating all instances of "NextJS" to "Next.js" for consistency.

-# Kinde NextJS
+# Kinde Next.js

-The Kinde SDK for NextJS.
+The Kinde SDK for Next.js.

-You can also use the NextJS starter kit [here](https://github.com/kinde-starter-kits/kinde-nextjs-app-router-starter-kit).
+You can also use the Next.js starter kit [here](https://github.com/kinde-starter-kits/kinde-nextjs-app-router-starter-kit).

-Please refer to the Kinde [NextJS SDK document](https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk/).
+Please refer to the Kinde [Next.js SDK document](https://docs.kinde.com/developer-tools/sdks/backend/nextjs-sdk/).
Tools
LanguageTool

[uncategorized] ~11-~11: The official spelling of this programming framework is “Next.js”.
Context: ...cumentation Please refer to the Kinde [NextJS SDK document](https://docs.kinde.com/de...

(NODE_JS)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 99a07f1 and 215b14c.

Files selected for processing (1)
  • readme.md (1 hunks)
Additional context used
LanguageTool
readme.md

[uncategorized] ~11-~11: The official spelling of this programming framework is “Next.js”.
Context: ...cumentation Please refer to the Kinde [NextJS SDK document](https://docs.kinde.com/de...

(NODE_JS)

Additional comments not posted (1)
readme.md (1)

11-11: LGTM! The hyperlink has been updated correctly.

The link now directs users to the official Kinde documentation, which improves accessibility.

Tools
LanguageTool

[uncategorized] ~11-~11: The official spelling of this programming framework is “Next.js”.
Context: ...cumentation Please refer to the Kinde [NextJS SDK document](https://docs.kinde.com/de...

(NODE_JS)

@DanielRivers DanielRivers merged commit 84caed4 into main Jul 28, 2024
3 checks passed
@DanielRivers DanielRivers deleted the clairekinde11-patch-1 branch July 28, 2024 19:24
peterphanouvong pushed a commit that referenced this pull request Aug 19, 2024
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