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

docs: fix online link error open #219

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

TaueFenCheng
Copy link

@TaueFenCheng TaueFenCheng commented Jan 24, 2025

docs: resize-observer live link can not open with github.io replace with vercel link

image

Summary by CodeRabbit

  • 文档
    • 更新了项目的演示站点 URL,现在指向新的部署地址。

Copy link

vercel bot commented Jan 24, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
resize-observer ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 24, 2025 3:27am

Copy link

coderabbitai bot commented Jan 24, 2025

概述

浏览

此次更改仅修改了 README.md 文件中的演示站点 URL。原有的 GitHub Pages 链接 https://react-component.github.io/resize-observer/ 被替换为新的 Vercel 部署地址 https://resize-observer-react-component.vercel.app/。更改非常简单,没有其他文档内容发生变化。

变更

文件 变更说明
README.md 更新演示站点 URL 为 Vercel 托管地址

诗歌

🐰 小兔子蹦蹦跳,
URL 换了新家桥,
Vercel 站点闪亮亮,
链接变得更清爽,
演示页面笑嘻嘻!


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

@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)
README.md (1)

18-18: 改进 Markdown 格式

建议将裸 URL 改为 Markdown 链接格式,以提高文档的可读性。

建议按照以下方式修改:

-https://resize-observer-react-component.vercel.app/
+[在线演示](https://resize-observer-react-component.vercel.app/)
🧰 Tools
🪛 Markdownlint (0.37.0)

18-18: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 42c60bf and fa81a99.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md

18-18: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
README.md (1)

18-18: 验证新的 Vercel 链接是否正常工作

让我们确保新的 Vercel 链接能够正常访问并且是项目的官方部署。

✅ Verification successful

建议改进文档链接的格式

链接可以正常访问,但建议按照 Markdown 最佳实践改进格式:

  • 将裸 URL https://resize-observer-react-component.vercel.app/ 改为标准 Markdown 链接格式:[在线演示](https://resize-observer-react-component.vercel.app/)
  • 建议添加简短的中文描述,以提高文档的可读性
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the new Vercel URL is accessible and returns a valid response

curl -I https://resize-observer-react-component.vercel.app/

Length of output: 909

🧰 Tools
🪛 Markdownlint (0.37.0)

18-18: null
Bare URL used

(MD034, no-bare-urls)

Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.07%. Comparing base (42c60bf) to head (fa81a99).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #219   +/-   ##
=======================================
  Coverage   94.07%   94.07%           
=======================================
  Files           5        5           
  Lines         135      135           
  Branches       38       38           
=======================================
  Hits          127      127           
  Misses          7        7           
  Partials        1        1           

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

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