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

Update metadata #56

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Update metadata #56

wants to merge 3 commits into from

Conversation

DonnaDuiker
Copy link
Contributor

@DonnaDuiker DonnaDuiker commented Mar 11, 2025

Describe the background of your pull request

Updating the metadata when you share the documentation link instead of the docs link: https://github.com/orgs/alkem-io/projects/22/views/5?pane=issue&itemId=97806290&issue=alkem-io%7Cproduct%7C1519

Additional context

Making sure metadata (title, description and image) is the same when you share the link alkem.io/documentation as when you share alkem.io/docs

Governance

Deployed to sandbox, so it can be tested from https://sandbox-alkem.io/documentation

By submitting this pull request I confirm that:

Summary by CodeRabbit

  • New Features
    • Enhanced social media shareability with additional metadata for optimized previews.
    • Improved SEO and user experience by updating document head information with a refined title, description, and imagery.

@DonnaDuiker DonnaDuiker requested a review from bobbykolev March 11, 2025 13:40
Copy link
Contributor

coderabbitai bot commented Mar 11, 2025

Walkthrough

This pull request enhances the project's SEO and social sharing capabilities by adding additional meta tags. In theme.config.jsx, several Open Graph and Twitter tags have been introduced to enrich how the site appears when shared on social media. In pages/_app.js, the Head component from Next.js is now used to include a page title and meta description directly in the document head.

Changes

File(s) Change Summary
theme.config.jsx, pages/_app.js Added and updated meta tags for social media sharing and SEO enhancements; extended configuration with Open Graph/Twitter tags and integrated Next.js Head elements.

Possibly related PRs

  • updated tagline client-web#7162: Updates to social meta tags in this PR relate closely to the similar meta tag enhancements performed here.
  • Fix updates #38: Modifications in meta tags within the configuration indicate a direct relationship with the current changes.

Suggested reviewers

  • keyboardguy25

Poem

Hop, hop, hop, I scurry in code delight,
Adding meta tags that make our project shine bright.
Open Graph, Twitter—each tag hops in tune,
SEO and social flair under a digital moon.
I'm a rabbit in code, celebrating this tweak,
With every hop, our project's profile peaks!


📜 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 5379260 and fb521b2.

📒 Files selected for processing (4)
  • theme.config.jsx (1 hunks)
  • pages/_app.js (2 hunks)
  • theme.config.jsx (1 hunks)
  • theme.config.jsx (1 hunks)
🔇 Additional comments (2)
pages/_app.js (1)

2-2: Well-implemented metadata addition for improved link sharing.

The addition of the Head component with title and description metadata enhances SEO and social media sharing capabilities, which aligns perfectly with the PR objective. The implementation follows Next.js best practices.

Also applies to: 17-20

theme.config.jsx (1)

19-35: Great implementation of comprehensive social media metadata.

The addition of Open Graph and Twitter card metadata will significantly improve how links appear when shared on social platforms, which aligns with the PR objective. The metadata is well-structured and consistent with what was added in _app.js.

Please verify that the image file referenced in the metadata (/alkemio-og.png) exists in the public directory to ensure social media platforms can display it correctly.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @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