Skip to content

Enhancement: Add metadata for key docs pages (#116)#138

Open
coolss21 wants to merge 1 commit into
Demon-Die:mainfrom
coolss21:feature/issue-116
Open

Enhancement: Add metadata for key docs pages (#116)#138
coolss21 wants to merge 1 commit into
Demon-Die:mainfrom
coolss21:feature/issue-116

Conversation

@coolss21

@coolss21 coolss21 commented Jun 10, 2026

Copy link
Copy Markdown

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.js metadata object directly. By providing a layout.tsx file for each directory, we can safely inject SEO titles and descriptions while preserving client interactivity.

Changes included

  • Created layout.tsx for /docs/quick-start
  • Created layout.tsx for /docs/learning-paths
  • Created layout.tsx for /docs/all-roadmaps
  • Created layout.tsx for /docs/common-questions

Summary by CodeRabbit

  • Documentation
    • Set up layout and metadata for four new documentation sections: All Roadmaps, Common Questions, Learning Paths, and Quick Start with descriptive page titles and descriptions.

@vercel

vercel Bot commented Jun 10, 2026

Copy link
Copy Markdown

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

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

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

Changes

Docs Metadata Configuration

Layer / File(s) Summary
Layout metadata exports
project/src/app/docs/all-roadmaps/layout.tsx, project/src/app/docs/common-questions/layout.tsx, project/src/app/docs/learning-paths/layout.tsx, project/src/app/docs/quick-start/layout.tsx
Four layout files export Next.js metadata with titles and descriptions ("All Roadmaps", "Common Questions", "Learning Paths", "Quick Start"), and simple Layout components that render children directly.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 Four docs now shine so bright,
With metadata set just right,
Quick Start, Paths, Questions too,
All Roadmaps for a clearer view—
SEO love from every page! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding metadata to key documentation pages.
Linked Issues check ✅ Passed All acceptance criteria from issue #116 are met: metadata added to 4 docs pages with specific titles and descriptions under 160 characters, and project builds successfully.
Out of Scope Changes check ✅ Passed All changes are directly aligned with issue #116 requirements: only layout.tsx files added to the four specified documentation directories.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
project/src/app/docs/all-roadmaps/layout.tsx (1)

3-6: ⚡ Quick win

Consider enriching metadata for better SEO consistency.

The metadata object includes only title and description. Other parts of the codebase (e.g., project/src/lib/roadmapSeo.tsx:164-197) use more complete metadata including keywords, openGraph, twitter, and alternates.canonical for 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

📥 Commits

Reviewing files that changed from the base of the PR and between cb4c939 and 9b046d7.

📒 Files selected for processing (4)
  • project/src/app/docs/all-roadmaps/layout.tsx
  • project/src/app/docs/common-questions/layout.tsx
  • project/src/app/docs/learning-paths/layout.tsx
  • project/src/app/docs/quick-start/layout.tsx

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.

Add metadata for docs pages

1 participant