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

Fix typo #2004

Closed
wants to merge 1 commit into from
Closed

Fix typo #2004

wants to merge 1 commit into from

Conversation

david8z
Copy link

@david8z david8z commented Jan 17, 2025

PR Description

Typo on docs

Summary by CodeRabbit

  • Documentation
    • Fixed a typo in the Vercel Edge example URL in the usage documentation to ensure users can correctly access the referenced example.

@david8z david8z requested a review from a team as a code owner January 17, 2025 19:55
@contributor-support
Copy link

Thank you @david8z for contributing this PR.
Please sign the Contributor License Agreement (CLA) before merging.

Copy link
Contributor

coderabbitai bot commented Jan 17, 2025

📝 Walkthrough

Walkthrough

The pull request involves a minor documentation correction in the USAGE.md file for the Vercel Edge section. The change addresses a typographical error in the example URL, correcting the misspelling of "vercel" from "vencel". This update ensures that users are directed to the correct GitHub repository example link.

Changes

File Change Summary
examples/serverless/USAGE.md Corrected URL from vencel-edge to vercel-edge in the documentation link

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f50a3c and 5a6ba97.

📒 Files selected for processing (1)
  • examples/serverless/USAGE.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • examples/serverless/USAGE.md

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

codecov bot commented Jan 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 61.27%. Comparing base (6f50a3c) to head (5a6ba97).
Report is 44 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2004   +/-   ##
=======================================
  Coverage   61.27%   61.27%           
=======================================
  Files         484      484           
  Lines       16615    16615           
  Branches     3337     3341    +4     
=======================================
  Hits        10181    10181           
- Misses       5197     5215   +18     
+ Partials     1237     1219   -18     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gitcommitshow
Copy link
Collaborator

@david8z I see this PR is pending CLA. Please sign the Contributor License Agreement (CLA), it cannot be merged without CLA.

Thanks

@saikumarrs
Copy link
Member

It has been addressed here, #2036.

@saikumarrs saikumarrs closed this Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants