Skip to content

feat: Enhance SEO with dynamic metadata generation#76

Merged
carhartlewis merged 1 commit into
mainfrom
lewis/risks
Feb 24, 2025
Merged

feat: Enhance SEO with dynamic metadata generation#76
carhartlewis merged 1 commit into
mainfrom
lewis/risks

Conversation

@carhartlewis
Copy link
Copy Markdown
Contributor

@carhartlewis carhartlewis commented Feb 24, 2025

  • Add new SEO utility function generatePageMeta() for flexible metadata configuration
  • Update layout and home page to use dynamic metadata generation
  • Add default Open Graph image for improved social sharing
  • Centralize SEO configuration with base metadata settings

Summary by CodeRabbit

  • New Features

    • Introduced a dynamic SEO metadata generation mechanism that adapts metadata content across pages.
  • Refactor

    • Transitioned from static metadata definitions to a flexible, function-based approach to improve consistency and manageability of page metadata.

- Add new SEO utility function `generatePageMeta()` for flexible metadata configuration
- Update layout and home page to use dynamic metadata generation
- Add default Open Graph image for improved social sharing
- Centralize SEO configuration with base metadata settings
@carhartlewis carhartlewis merged commit e75a392 into main Feb 24, 2025
@vercel
Copy link
Copy Markdown

vercel Bot commented Feb 24, 2025

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

Name Status Preview Comments Updated (UTC)
web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 24, 2025 3:58pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
app ⬜️ Skipped (Inspect) Feb 24, 2025 3:58pm
comp-portal ⬜️ Skipped (Inspect) Feb 24, 2025 3:58pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 24, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request modifies the metadata handling for web pages. In the home page file, a static metadata export was removed, while the layout file now calls a dynamic metadata generator instead of using hardcoded values. Additionally, a new SEO utility file has been added which defines constants and a function to generate comprehensive metadata. These changes shift metadata management from static definitions to a function-based, dynamic approach.

Changes

File(s) Change Summary
apps/web/src/app/(home)/page.tsx
apps/web/src/app/layout.tsx
Removed static metadata export from page.tsx and updated layout.tsx to replace hardcoded metadata with a dynamic generator call via generatePageMeta.
apps/web/src/lib/seo.tsx Introduced a new file that defines SEO constants and the generatePageMeta function to assemble comprehensive metadata dynamically, integrating Open Graph and Twitter data.

Sequence Diagram(s)

sequenceDiagram
    participant Browser
    participant Layout as Layout.tsx
    participant SEO as seo.tsx (generatePageMeta)
    
    Browser->>Layout: Request page
    Layout->>SEO: Call generatePageMeta({ url: "/" })
    SEO-->>Layout: Return dynamic metadata
    Layout-->>Browser: Serve page with generated metadata
Loading

Possibly related PRs

  • style: homepage updates #62: Addresses similar modifications in the metadata export in page.tsx, aligning metadata structure updates across the codebase.

Poem

I'm a rabbit with a code-filled heart,
Hopping through changes, a brand new start.
Static bits left behind in the burrow's dust,
Dynamic metadata now shines with trust.
With each line of code, my joy does bloom –
In SEO fields, I dance, leaping past gloom!


📜 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 ea7e836 and 7585a38.

⛔ Files ignored due to path filters (1)
  • apps/web/public/og.png is excluded by !**/*.png
📒 Files selected for processing (3)
  • apps/web/src/app/(home)/page.tsx (0 hunks)
  • apps/web/src/app/layout.tsx (1 hunks)
  • apps/web/src/lib/seo.tsx (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

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