Skip to content

Conversation

@amaan-bhati
Copy link
Member

What has changed?

  • Injects Organization JSON‑LD into the docs head to link the site to the Keploy entity.
  • Adds dynamic BreadcrumbList JSON‑LD across docs pages to expose hierarchy to search engines.
  • Adds per‑page Article JSON‑LD with title/description/date metadata for better indexing.
  • Out of scope: BlogPosting, APIReference, and WebSite/SearchAction schemas are not included.

This PR Resolves : keploy/keploy#3426

Type of change

  • New feature (non-breaking change which adds functionality).

Changes (objects + where + why)

  • Organization JSON‑LD

    • Where: docusaurus.config.js
    • How/why: Added via themeConfig.headTags so it renders in <head> site‑wide and declares the Keploy organization.
  • BreadcrumbList JSON‑LD

    • Where: index.js (/theme/DocBreadCrumbs)
    • How/why: Built from Docusaurus sidebar breadcrumbs and injected into <head> using @docusaurus/Head, giving a real hierarchy (Home → Docs → … → Page).
  • Article JSON‑LD

    • Where: index.js (theme/DocItem/index.js)
    • How/why: Rendered per doc page in <head> using title/description and update timestamps to improve content indexing.

How Has This Been Tested?

Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.

  • Start the site:
    npm run start

  • Open the docs homepage and any docs page.

  • In DevTools, open the Elements panel and expand .

  • Search for and screenshot:

    • application/ld+json script tags
    • Organization object

Screenshot 2025-12-30 at 2 51 01 AM
  • BreadcrumbList object

Screenshot 2025-12-30 at 2 50 22 AM
  • Article object

Screenshot 2025-12-30 at 2 51 36 AM

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

name: "Keploy Documentation",
url: "https://keploy.io/docs/",
potentialAction: {
"@type": "SearchAction",
Copy link
Member Author

Choose a reason for hiding this comment

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

For this section, it would be useful in the future when we add search queries as a url similar to the blog website

Copy link
Contributor

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

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

Hey @amaan-bhati the changes looks good, but the json-ld is not showing in the docs landing page

@nehagup nehagup merged commit 502029a into keploy:main Dec 30, 2025
4 of 6 checks passed
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.

[docs]: Add JSON‑LD structured data (Organization, BreadcrumbList, Article) to docs

3 participants