Add structured data and mobile viewport for AI-friendly SEO#367
Add structured data and mobile viewport for AI-friendly SEO#367JakeSCahill merged 4 commits intomainfrom
Conversation
This commit improves the documentation site's discoverability and usability for both AI crawlers and end users. Changes: - Add mobile viewport meta tag for responsive design - Add JSON-LD structured data with Organization schema - Add WebSite schema with SearchAction for site search - Include social media links (sameAs) for knowledge graph - Add contact information for better organization visibility These improvements help search engines and AI assistants better understand our site structure, content, and organization identity.
✅ Deploy Preview for docs-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis pull request adds SEO-related enhancements to the HTML head section of the site. It introduces a responsive viewport meta tag for mobile compatibility, adds a new head partial containing JSON-LD structured data for search engine optimization (organization and website information), and includes this new partial in the main head template. The changes are purely additive—no existing logic or functionality is modified. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/partials/head-structured-data.hbs (1)
7-12: Avoid baking production URLs into this shared partial.Every entity ID and endpoint here is fixed to the live hosts. That makes preview/local renders emit structured data for a different site, which is brittle for validation and risky if a non-prod build is ever exposed. Prefer deriving the base URL from site config, or only rendering this block in production.
Also applies to: 27-27, 32-43
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/partials/head-structured-data.hbs` around lines 7 - 12, The JSON-LD in head-structured-data.hbs currently hardcodes production URLs for "@id", "url", and "logo.url"; change these to use the site's configured base URL instead (e.g., derive a base URL from the template/site config variable such as site.baseUrl or site.url) or conditionally render the entire JSON-LD block only when running in production. Update the "@id", "url", and the nested "logo" "url" values to be constructed from that base URL variable (e.g., base + path) and ensure any checks (isProduction or environment flag) guard output if you prefer runtime gating.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/partials/head-structured-data.hbs`:
- Around line 17-22: The schema's "sameAs" array includes a product repo URL
instead of the organization profile; update the entry in the sameAs array in
src/partials/head-structured-data.hbs by replacing
"https://github.com/redpanda-data/redpanda" with the Redpanda organization
profile URL ("https://github.com/redpanda-data") so the sameAs links
consistently represent the Redpanda Data organization entity.
---
Nitpick comments:
In `@src/partials/head-structured-data.hbs`:
- Around line 7-12: The JSON-LD in head-structured-data.hbs currently hardcodes
production URLs for "@id", "url", and "logo.url"; change these to use the site's
configured base URL instead (e.g., derive a base URL from the template/site
config variable such as site.baseUrl or site.url) or conditionally render the
entire JSON-LD block only when running in production. Update the "@id", "url",
and the nested "logo" "url" values to be constructed from that base URL variable
(e.g., base + path) and ensure any checks (isProduction or environment flag)
guard output if you prefer runtime gating.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 29a21eef-5ba4-4536-b4d8-69a3e3517b10
📒 Files selected for processing (3)
src/partials/head-meta.hbssrc/partials/head-structured-data.hbssrc/partials/head.hbs
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
| "width": 512, | ||
| "height": 512 | ||
| }, | ||
| "description": "Redpanda is a streaming data platform for developers. Build real-time applications without the complexity of legacy platforms.", |
There was a problem hiding this comment.
I think this needs to be updated to include something about RP Agentic Data Plane. It has become an key differentiator for our company and is going to be a principal organizational element in our docs when we reorg. I know @emaxerrno is not a fan of "platform" in our mission description.
| "@id": "https://docs.redpanda.com/#website", | ||
| "url": "https://docs.redpanda.com", | ||
| "name": "Redpanda Documentation", | ||
| "description": "Redpanda Documentation: Guides, API references, and resources for event streaming.", |
There was a problem hiding this comment.
Again, I think Agentic Data Plane needs to be part of this description.
Feediver1
left a comment
Feediver1
left a comment
There was a problem hiding this comment.
Approving, but please update descriptions to include that we are both a streaming and Agentic Data Plane company.
- Change GitHub sameAs link to organization profile (redpanda-data) - Update description to include 'Agentic Data Plane' - Make WebSite schema URLs dynamic using site.url variable - Keep Organization schema URLs hardcoded (company, not docs site)
2 participants
Summary
This PR enhances the documentation site's discoverability and usability for both AI systems and end users by implementing Schema.org structured data and improving mobile responsiveness.
Changes
head-structured-data.hbspartial with Organization and WebSite schemassameAspropertyBenefits for AI Systems
Search Engines & AI Crawlers
AI Assistants (ChatGPT, Claude, etc.)
Benefits for End Users
Mobile Users
Search Experience
Trust & Credibility
Verification
Tested locally with
gulp previewand verified using Playwright:SEO Impact
Based on GPT audit criteria, these changes address 5 critical SEO issues: