DOC-920 | Add structured data markup - #1038
Conversation
|
Deploy Preview Available Via |
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📝 WalkthroughWalkthroughA new Hugo partial generates JSON-LD structured data from page and site metadata, choosing ChangesJSON-LD Structured Data
Estimated code review effort: 2 (Simple) | ~10 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@site/themes/arangodb-docs-theme/layouts/partials/structured-data.html`:
- Around line 17-26: The opt-out check for `schema: none` is only applied within
the `.IsPage` branch, preventing the home page (`.IsHome`) from opting out of
schema generation. Move the condition that checks `ne (lower (.Params.schema |
default "")) "none"` to wrap around both the `.IsHome` and `.IsPage` blocks, or
alternatively add this same opt-out check inside the `.IsHome` block before the
schema assignment to ensure both page types respect the `schema: none`
configuration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9d9d0ef6-80c7-46b0-9575-c48fbdfd9d8f
📒 Files selected for processing (2)
site/themes/arangodb-docs-theme/layouts/partials/head.htmlsite/themes/arangodb-docs-theme/layouts/partials/structured-data.html
|
Bugbot is not enabled for this team, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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.
Inline comments:
In `@site/themes/arangodb-docs-theme/layouts/partials/structured-data.html`:
- Around line 23-27: The structured-data branch currently assigns TechArticle to
both .IsPage and .IsSection. Update the conditional around the $schema
assignment so TechArticle remains limited to .IsPage, and provide .IsSection
with an appropriate section or collection schema type without article-specific
properties such as headline, author, or mainEntityOfPage.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 1ff5ed08-8647-4d9e-acae-c29186480c9f
📒 Files selected for processing (2)
site/themes/arangodb-docs-theme/layouts/partials/head.htmlsite/themes/arangodb-docs-theme/layouts/partials/structured-data.html
🚧 Files skipped from review as they are similar to previous changes (1)
- site/themes/arangodb-docs-theme/layouts/partials/head.html
Description
Upstream PRs
Summary by CodeRabbit
WebSiteschema for the homepage andTechArticleschema for content and section pages.