Enhancement: Add metadata for key docs pages (#116)#138
Conversation
|
@rhoggs-bot-test-account is attempting to deploy a commit to the Rishi Bhardwaj's projects Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughFour documentation pages receive Next.js App Router metadata exports and simple layout components. Each layout file adds a metadata constant with a page-specific title and description, and exports a default Layout component that renders children without modification. ChangesDocs Metadata Configuration
🎯 1 (Trivial) | ⏱️ ~3 minutes
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
project/src/app/docs/all-roadmaps/layout.tsx (1)
3-6: ⚡ Quick winConsider enriching metadata for better SEO consistency.
The metadata object includes only
titleanddescription. Other parts of the codebase (e.g.,project/src/lib/roadmapSeo.tsx:164-197) use more complete metadata includingkeywords,openGraph,alternates.canonicalfor enhanced SEO and social sharing. While the current implementation meets requirements, enriching these docs pages with similar metadata would improve discoverability and sharing experience.✨ Example enhanced metadata
export const metadata: Metadata = { title: "All Roadmaps", description: "Browse all available DemonTech roadmaps. Discover paths for frontend, backend, devops, data science, and more.", + keywords: ["roadmaps", "developer roadmaps", "learning paths", "tech careers"], + alternates: { + canonical: "/docs/all-roadmaps", + }, + openGraph: { + title: "All Roadmaps | Demon Tech Roadmap", + description: "Browse all available DemonTech roadmaps. Discover paths for frontend, backend, devops, data science, and more.", + type: "website", + }, };🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@project/src/app/docs/all-roadmaps/layout.tsx` around lines 3 - 6, The metadata object exported as `metadata: Metadata` only has title and description; update it to match the richer SEO shape used by the roadmapSEO helper (see the roadmapSeo module) by adding `keywords` (string[]), an `openGraph` object (title, description, url/canonical, images, siteName, type, locale), a `twitter` object (card, title, description, images), and `alternates.canonical` pointing to the canonical page URL; ensure values reuse the existing title/description and add appropriate keywords and image URL(s) consistent with other roadmaps so sharing and SEO metadata are consistent across the site.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@project/src/app/docs/all-roadmaps/layout.tsx`:
- Around line 3-6: The metadata object exported as `metadata: Metadata` only has
title and description; update it to match the richer SEO shape used by the
roadmapSEO helper (see the roadmapSeo module) by adding `keywords` (string[]),
an `openGraph` object (title, description, url/canonical, images, siteName,
type, locale), a `twitter` object (card, title, description, images), and
`alternates.canonical` pointing to the canonical page URL; ensure values reuse
the existing title/description and add appropriate keywords and image URL(s)
consistent with other roadmaps so sharing and SEO metadata are consistent across
the site.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 2c9b1df7-1ed2-4e0d-9704-d74bf5c7e490
📒 Files selected for processing (4)
project/src/app/docs/all-roadmaps/layout.tsxproject/src/app/docs/common-questions/layout.tsxproject/src/app/docs/learning-paths/layout.tsxproject/src/app/docs/quick-start/layout.tsx
Resolves #116
Overview
This PR introduces SEO metadata for several key documentation pages (Quick Start, Learning Paths, All Roadmaps, and Common Questions).
Why this helps
Since these pages are
"use client"components, they cannot export the Next.jsmetadataobject directly. By providing alayout.tsxfile for each directory, we can safely inject SEO titles and descriptions while preserving client interactivity.Changes included
layout.tsxfor/docs/quick-startlayout.tsxfor/docs/learning-pathslayout.tsxfor/docs/all-roadmapslayout.tsxfor/docs/common-questionsSummary by CodeRabbit