Skip to content

DOC-920 | Add structured data markup - #1038

Open
nicos-arango wants to merge 11 commits into
mainfrom
DOC-920
Open

DOC-920 | Add structured data markup#1038
nicos-arango wants to merge 11 commits into
mainfrom
DOC-920

Conversation

@nicos-arango

@nicos-arango nicos-arango commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Description

Upstream PRs

  • 3.10:
  • 3.11:
  • 3.12:
  • 4.0:

Summary by CodeRabbit

  • New Features
    • Added JSON-LD structured data to documentation pages to support richer search results.
    • Generates appropriate WebSite schema for the homepage and TechArticle schema for content and section pages.
    • Includes organization, publisher, author, description, language, and available modification-date metadata, rendering structured data only when applicable.

@arangodb-docs-automation

Copy link
Copy Markdown
Contributor

Deploy Preview Available Via
https://deploy-preview-1038--docs-hugo.netlify.app

@cla-bot cla-bot Bot added the cla-signed label Jun 23, 2026
@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2ecb8386-65b7-4517-886b-91b4988287a3

📝 Walkthrough

Walkthrough

A new Hugo partial generates JSON-LD structured data from page and site metadata, choosing WebSite or TechArticle output by page type. The theme head template now includes this partial.

Changes

JSON-LD Structured Data

Layer / File(s) Summary
Structured data partial and head wiring
site/themes/arangodb-docs-theme/layouts/partials/structured-data.html, site/themes/arangodb-docs-theme/layouts/partials/head.html
Adds a structured-data.html partial that emits JSON-LD with publisher metadata, page fields, language fallback, and optional dateModified, then includes it in <head>.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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 describes the addition of structured data markup shown in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-920

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between dd4229d and e968f0a.

📒 Files selected for processing (2)
  • site/themes/arangodb-docs-theme/layouts/partials/head.html
  • site/themes/arangodb-docs-theme/layouts/partials/structured-data.html

Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
@cursor

cursor Bot commented Jul 7, 2026

Copy link
Copy Markdown

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.

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6e16612 and 44c0e11.

📒 Files selected for processing (2)
  • site/themes/arangodb-docs-theme/layouts/partials/head.html
  • site/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

Comment thread site/themes/arangodb-docs-theme/layouts/partials/structured-data.html Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants