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: incorrect domain for images #3843

Merged
merged 1 commit into from
Oct 5, 2024
Merged

fix: incorrect domain for images #3843

merged 1 commit into from
Oct 5, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Oct 4, 2024

Closes #

📝 Description

due to the domain migration, some outdated image paths failed.

⛳️ Current behavior (updates)

image

🚀 New behavior

image

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Updated documentation links to point to the new nextui.org domain.
    • Changed image sources in the documentation to reflect the new URLs.
  • Tests

    • Added comprehensive tests for the Dropdown component, covering rendering, interactions, keyboard navigation, and accessibility checks.

Copy link

vercel bot commented Oct 4, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 5:07pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 5:07pm

Copy link

changeset-bot bot commented Oct 4, 2024

⚠️ No Changeset found

Latest commit: 974f082

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Oct 4, 2024

Walkthrough

The pull request includes updates to URLs within the documentation and components of the project. Specifically, the docs link in the siteConfig object has been changed to point to "https://nextui.org". Additionally, multiple image source URLs in the Image component files have been updated to reflect the new domain. Furthermore, extensive tests for the Dropdown component have been added, covering various rendering and interaction scenarios.

Changes

File Path Change Summary
apps/docs/config/site.ts Updated docs link from "https://nextui-docs-v2.vercel.app" to "https://nextui.org".
apps/docs/content/components/image/*.ts Updated src attributes for images from "https://nextui-docs-v2.vercel.app" to "https://nextui.org".
packages/components/dropdown/tests/dropdown.test.tsx Added comprehensive tests for the Dropdown component, covering rendering, interaction, and accessibility.

Possibly related PRs

  • fix(docs): incorrect image height in documentation #3427: The changes in this PR involve updating image sources in documentation, which is related to the main PR's update of URLs in the siteConfig object, indicating a broader effort to standardize links across documentation.
  • fix(docs): broken links #3796: This PR fixes broken links in documentation, which is directly relevant to the main PR's focus on updating URLs in the siteConfig.

Suggested labels

📋 Scope : Docs


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3f8b63e and 974f082.

📒 Files selected for processing (8)
  • apps/docs/config/site.ts (1 hunks)
  • apps/docs/content/components/image/blurred.ts (1 hunks)
  • apps/docs/content/components/image/fallback.ts (1 hunks)
  • apps/docs/content/components/image/loading.ts (1 hunks)
  • apps/docs/content/components/image/nextjs.ts (1 hunks)
  • apps/docs/content/components/image/usage.ts (1 hunks)
  • apps/docs/content/components/image/zoomed.ts (1 hunks)
  • packages/components/dropdown/tests/dropdown.test.tsx (1 hunks)
✅ Files skipped from review due to trivial changes (6)
  • apps/docs/content/components/image/blurred.ts
  • apps/docs/content/components/image/fallback.ts
  • apps/docs/content/components/image/loading.ts
  • apps/docs/content/components/image/nextjs.ts
  • apps/docs/content/components/image/usage.ts
  • apps/docs/content/components/image/zoomed.ts
🔇 Additional comments (2)
apps/docs/config/site.ts (1)

36-36: LGTM! Verify other occurrences of the old domain.

The update of the docs link to "https://nextui.org" is correct and consistent with other URLs in the file. This change aligns with the PR objectives to fix incorrect domains for images due to the recent domain migration.

To ensure all instances of the old domain have been updated, please run the following verification script:

If the script returns any results, those occurrences should also be updated to the new domain.

✅ Verification successful

[/run_scripts]


All instances of the old domain have been successfully updated.

No remaining instances of "nextui-docs-v2.vercel.app" were found in the codebase. The update to "https://nextui.org" is consistent and complete.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for any remaining instances of the old domain across all files

# Test: Search for the old domain. Expect: No results
rg "nextui-docs-v2.vercel.app" --type-not git

Length of output: 73


Script:

#!/bin/bash
# Description: Search for any remaining instances of the old domain across all files

# Test: Search for the old domain. Expect: No results
rg "nextui-docs-v2.vercel.app"

Length of output: 30

packages/components/dropdown/__tests__/dropdown.test.tsx (1)

529-531: Verify that all image URLs use the correct domain

The image source in line 529 has been updated to 'https://nextui.org/images/hero-card-complete.jpeg'. To ensure consistency across the codebase and prevent any broken image links due to the domain migration, please verify that all image URLs have been updated to use the new domain 'nextui.org'.

Run the following script to find any image URLs not using 'https://nextui.org/':


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 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.

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.

@jrgarciadev jrgarciadev merged commit a07f887 into main Oct 5, 2024
3 checks passed
@jrgarciadev jrgarciadev deleted the fix/missing-images branch October 5, 2024 15:31
@coderabbitai coderabbitai bot mentioned this pull request Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Scope : Docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants