Skip to content

[TASK-7545] fix(footer): make docs external link#567

Merged
Hugo0 merged 1 commit intomainfrom
fix/footer-doc-link
Dec 13, 2024
Merged

[TASK-7545] fix(footer): make docs external link#567
Hugo0 merged 1 commit intomainfrom
fix/footer-doc-link

Conversation

@jjramirezn
Copy link
Copy Markdown
Contributor

@jjramirezn jjramirezn commented Dec 13, 2024

Summary by CodeRabbit

  • New Features

    • Updated the 'Docs' link in the footer to an absolute URL for easier access.
    • Enhanced the footer link behavior to open external links in a new tab.
  • Bug Fixes

    • Improved link handling to ensure correct behavior for internal and external links.

@vercel
Copy link
Copy Markdown

vercel bot commented Dec 13, 2024

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

Name Status Preview Comments Updated (UTC)
peanut-ui 🔄 Building (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 0:36am

@notion-workspace
Copy link
Copy Markdown

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Dec 13, 2024

Walkthrough

The changes in this pull request involve modifications to the LINKS constant in the Footer component's constants file and an update to the Footer component itself. The URL for the 'Docs' entry has been changed from a relative path to an absolute URL. Additionally, a new conditional expression has been added to the target attribute of the Link component, ensuring that external links open in a new tab while internal links do not.

Changes

File Path Change Summary
src/components/Global/Footer/consts.ts Updated 'Docs' entry URL from '/docs' to 'https://docs.peanut.to'.
src/components/Global/Footer/index.tsx Added conditional expression for target attribute in Link component to handle external links.

Poem

In the footer where links do play,
A new path shines bright, leading the way.
With a click, the docs now open wide,
In a new tab, let knowledge abide!
Hopping along, the rabbit does cheer,
For changes that bring us all near! 🐇✨


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. (Experiment)
  • @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.

@jjramirezn jjramirezn requested a review from Hugo0 December 13, 2024 12:36
Copy link
Copy Markdown
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: 1

🧹 Outside diff range and nitpick comments (2)
src/components/Global/Footer/consts.ts (1)

Line range hint 1-50: Consider extracting duplicate URLs to constants.

The docs URL 'https://docs.peanut.to' appears in both SOCIALS and LINKS arrays. Consider extracting common URLs to shared constants to improve maintainability.

 import * as icons from '@/assets/icons'

+const EXTERNAL_URLS = {
+    DOCS: 'https://docs.peanut.to',
+    TWITTER: 'https://twitter.com/peanutprotocol',
+    DISCORD: 'https://discord.gg/BX9Ak7AW28',
+    GITHUB: 'https://github.com/peanutprotocol/',
+}
+
 export const SOCIALS = [
     {
         name: 'twitter',
-        url: 'https://twitter.com/peanutprotocol',
+        url: EXTERNAL_URLS.TWITTER,
         logoSrc: icons.TWITTER_ICON.src,
     },
     // ... other socials with similar changes
     {
         name: 'gitbook',
-        url: 'https://docs.peanut.to',
+        url: EXTERNAL_URLS.DOCS,
         logoSrc: icons.GITBOOK_ICON.src,
     },
 ]

 export const LINKS = [
     {
         name: 'Docs',
-        url: 'https://docs.peanut.to',
+        url: EXTERNAL_URLS.DOCS,
     },
     // ... rest of the links
 ]
src/components/Global/Footer/index.tsx (1)

Line range hint 12-36: Consider unifying external link handling.

The component handles external links differently between SOCIALS (hardcoded target="_blank") and LINKS (conditional target). Consider extracting this logic into a shared utility function for consistency.

+const getExternalLinkProps = (url: string) => ({
+    target: url.startsWith('http') ? '_blank' : undefined,
+    rel: url.startsWith('http') ? 'noopener noreferrer' : undefined,
+});
+
 const Footer = () => {
     return (
         // ...
         {_consts.SOCIALS.map((social) => (
             <Link
                 key={social.name}
                 href={social.url}
-                target="_blank"
+                {...getExternalLinkProps(social.url)}
             >
         ))}
         // ...
         {_consts.LINKS.map((link) => (
             <Link
                 key={link.name}
                 href={link.url}
-                target={link.url.startsWith('http') ? '_blank' : undefined}
+                {...getExternalLinkProps(link.url)}
             >
         ))}
         // ...
     );
 };
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2b2dacb and 976b129.

📒 Files selected for processing (2)
  • src/components/Global/Footer/consts.ts (1 hunks)
  • src/components/Global/Footer/index.tsx (1 hunks)
🔇 Additional comments (1)
src/components/Global/Footer/consts.ts (1)

29-29: LGTM! URL change aligns with external docs strategy.

The change from relative to absolute URL is consistent with the existing external docs URL pattern in the SOCIALS constant.

<Link
key={link.name}
href={link.url}
target={link.url.startsWith('http') ? '_blank' : undefined}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add security attributes for external links.

When opening links in new tabs using target="_blank", it's important to include rel="noopener noreferrer" to prevent potential security vulnerabilities.

-target={link.url.startsWith('http') ? '_blank' : undefined}
+target={link.url.startsWith('http') ? '_blank' : undefined}
+rel={link.url.startsWith('http') ? 'noopener noreferrer' : undefined}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
target={link.url.startsWith('http') ? '_blank' : undefined}
target={link.url.startsWith('http') ? '_blank' : undefined}
rel={link.url.startsWith('http') ? 'noopener noreferrer' : undefined}

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