Draft - Better SEO descriptions

[kotAPI]

Summary by CodeRabbit

• New Features

  • Introduced automated SEO metadata generation for documentation pages, including improved Open Graph and Twitter card support.
  • Added SEO metadata to contributing and Accordion component documentation pages for enhanced search engine visibility.

• Refactor

  • Updated the structure and handling of SEO metadata across documentation pages for consistency and maintainability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This change restructures how SEO metadata is managed in the documentation for the Accordion component and several contributing guides. It removes the old static SEO metadata file for the Accordion and introduces a reusable utility function to generate SEO metadata dynamically. New seo.ts modules are added for the Accordion and each contributing documentation section, each exporting a tailored metadata object. The relevant MDX pages are updated to import and export these new metadata objects. Two new utility functions are introduced to standardize Open Graph image URL generation and metadata creation.

Changes

File(s)	Change Summary
docs/app/docs/components/accordion/docs/seo/index.js	Removed the static SEO metadata file for the Accordion documentation.
docs/app/docs/components/accordion/page.mdx	Updated to import and export the new accordionMetadata from the new SEO module instead of the old static metadata.
docs/app/docs/components/accordion/seo.ts	Added a new module that generates and exports SEO metadata for the Accordion docs using the new utility.
docs/app/docs/contributing/before-you-start/page.mdx .../contributing-to-rad-ui/page.mdx .../setting-up-dev-environment/page.mdx	Added imports and exports for new SEO metadata objects in each contributing guide MDX page.
docs/app/docs/contributing/before-you-start/seo.ts .../contributing-to-rad-ui/seo.ts .../setting-up-dev-environment/seo.ts	Added new modules that generate and export SEO metadata for each contributing guide using the new utility.
docs/utils/seo/generateSeoMetadata.ts	Added a utility function to generate SEO metadata objects, including Open Graph and Twitter metadata, based on input parameters.
docs/utils/seo/helpers/generateOgTitle.ts	Added a helper function to generate Open Graph image URLs using the title and description as query parameters.

Sequence Diagram(s)

sequenceDiagram
    participant MDXPage as Documentation Page (.mdx)
    participant SEO as SEO Module (seo.ts)
    participant Utils as generateSeoMetadata Utility
    participant Helper as generateOgTitleUrl Helper

    MDXPage->>SEO: import { metadata }
    SEO->>Utils: generateSeoMetadata({title, description, keywords})
    Utils->>Helper: generateOgTitleUrl(title, description)
    Helper-->>Utils: Open Graph image URL
    Utils-->>SEO: SEO metadata object
    SEO-->>MDXPage: metadata export

Loading

Possibly related PRs

• Improve Accordion SEO #1028: Originally introduced the old index.js metadata file and its usage in the Accordion docs page; this PR directly modifies and replaces that SEO metadata setup.

Poem

In docs where rabbits hop and play,
SEO now finds a modern way.
With helpers and utilities neat,
Each guide’s metadata is complete.
Accordion’s secrets, guides anew,
All shine brighter for me and you!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/app/docs/components/accordion/seo.ts

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/app/docs/contributing/contributing-to-rad-ui/seo.ts

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/app/docs/contributing/setting-up-dev-environment/seo.ts

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

• 3 others

---

📜 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 c25945a and cd5b7e8.

📒 Files selected for processing (11)

• docs/app/docs/components/accordion/docs/seo/index.js (0 hunks)
• docs/app/docs/components/accordion/page.mdx (1 hunks)
• docs/app/docs/components/accordion/seo.ts (1 hunks)
• docs/app/docs/contributing/before-you-start/page.mdx (1 hunks)
• docs/app/docs/contributing/before-you-start/seo.ts (1 hunks)
• docs/app/docs/contributing/contributing-to-rad-ui/page.mdx (1 hunks)
• docs/app/docs/contributing/contributing-to-rad-ui/seo.ts (1 hunks)
• docs/app/docs/contributing/setting-up-dev-environment/page.mdx (1 hunks)
• docs/app/docs/contributing/setting-up-dev-environment/seo.ts (1 hunks)
• docs/utils/seo/generateSeoMetadata.ts (1 hunks)
• docs/utils/seo/helpers/generateOgTitle.ts (1 hunks)

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.