Skip to content

add json-ld metadata #2876

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Aug 7, 2025
Merged

add json-ld metadata #2876

merged 17 commits into from
Aug 7, 2025

Conversation

aelmanaa
Copy link
Collaborator

@aelmanaa aelmanaa commented Aug 5, 2025

This pull request implements a comprehensive SEO metadata and structured data (JSON-LD) system for documentation pages, enhancing search engine discoverability and supporting advanced features like estimated reading time, difficulty, and publication dates. The changes introduce a new StructuredData component, extend content metadata schemas, and update documentation content to provide richer SEO information.

SEO Structured Data Implementation

  • Added the StructuredData.astro component to render Schema.org-compliant JSON-LD structured data for all documentation pages, powered by a new generateStructuredData utility. (src/components/StructuredData.astro, src/components/HeadSEO.astro, [1] [2] [3] [4]
  • Updated the HeadSEO.astro component to inject structured data and support both standard metadata and quickstart-specific frontmatter for SEO. (src/components/HeadSEO.astro, [1] [2] [3]
  • Updated BaseLayout.astro and QuickstartLayout.astro to pass new metadata and quickstart frontmatter to the SEO component for consistent structured data injection. (src/layouts/BaseLayout.astro, src/layouts/QuickstartLayout.astro, [1] [2]

Metadata Schema Enhancements

  • Extended the content metadata schema in content.config.ts to support new fields required for structured data: estimatedTime, difficulty, datePublished, lastModified, version, etc., for both general docs and quickstarts. (src/content.config.ts, [1] [2] [3]

Documentation Content Enrichment

  • Updated multiple documentation pages (API references, tutorials, quickstarts, and concepts) to include the new SEO metadata fields, such as excerpt, version, datePublished, lastModified, difficulty, and estimatedTime, ensuring richer and more accurate structured data. (src/content/ccip/api-reference/evm/v1.6.0/*.mdx, src/content/ccip/concepts/architecture/overview.mdx, src/content/ccip/tutorials/evm/transfer-tokens-from-contract.mdx, src/content/quickstarts/ccip-direct-staking.mdx, [1] [2] [3] [4] [5] [6] [7]

Documentation and Guidance

  • Added a reference to the new SEO Metadata Guide in the README.md, providing technical writers with instructions for using the new system. (README.md, README.mdR28)

@aelmanaa aelmanaa requested a review from a team as a code owner August 5, 2025 17:17
Copy link

vercel bot commented Aug 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Aug 7, 2025 0:14am

Copy link
Contributor

github-actions bot commented Aug 5, 2025

👋 aelmanaa, thanks for creating this pull request!

To help reviewers, please consider creating future PRs as drafts first. This allows you to self-review and make any final changes before notifying the team.

Once you're ready, you can mark it as "Ready for review" to request feedback. Thanks!

khadni
khadni previously approved these changes Aug 6, 2025
@aelmanaa aelmanaa merged commit 3f5eb4a into main Aug 7, 2025
22 checks passed
@aelmanaa aelmanaa deleted the json-ld branch August 7, 2025 12:24
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.

2 participants