seo: HowTo schema, glossary DefinedTermSet, docs landing fixes

Audit findings on keploy.io/docs and follow-up coverage.

Critical fixes:
- /docs/ landing was rendering zero H1, with title "Keploy Documentation"
  (20 chars) and description "API Test Generator Tool" (23 chars). Both too
  short to capture docs intent (install, capture, replay, SDK). Added an
  sr-only H1 plus a longer Layout title/description on src/pages/index.js
  ("Keploy Documentation — Install, Capture & Replay API Tests" + a 159-char
  description covering install, capture, CI replay, SDK references).
- src/pages/about.js shipped zero JSON-LD because src/pages/* are not covered
  by the docs schema plugin. Inlined Article + BreadcrumbList JSON-LD via
  @docusaurus/Head.
- src/pages/concepts/reference/glossary.js shipped zero JSON-LD too. Now
  emits a single DefinedTermSet from the entire glossaryEntries data, with
  one DefinedTerm per glossary entry. Mirrors the pattern in landing's
  /what-is-api-testing layout.
- Docusaurus sitemap noIndex on 1.0.0 / 2.0.0 archives + ignorePatterns to
  drop /tags/** and /1.0.0/** /2.0.0/** from the generated sitemap. Reduces
  crawl-budget dilution; preserves the recently-added priority bucket
  comments above the sitemap config.

HowTo schema rollout:
- New src/components/HowTo.js wrapper. API:
    <HowTo
      name="Install Keploy on Linux"
      totalTime="PT5M"
      tools={[...]} supplies={[...]}
      steps={[{name, text, url}, ...]}
      visible={true|false}
    />
  Emits valid HowTo JSON-LD via @docusaurus/Head and (when visible) renders
  a numbered <ol>. Use visible={false} on pages that already render the
  steps in prose to avoid duplicate UI.
- Applied to versioned_docs/version-4.0.0/server/installation.md (visible
  HowTo above the existing prose).
- Applied to all 32 quickstart pages in versioned_docs/version-4.0.0/quickstart
  with visible={false} (existing tutorial prose remains; only schema is added).

SDK-installation title alignment:
- /docs/server/sdk-installation/go|python|javascript pages had H1/title
  "Merge Test Coverage Data" while the URL says "sdk-installation". Title
  rewritten to "Keploy [Language] SDK — Install & Merge Test Coverage" so
  URL and content topic align without renaming the route or moving files.
  java.md is unchanged here — upstream main has rewritten that file as
  the Enterprise dynamic-deduplication agent guide, so the SDK-install
  framing no longer applies to it.

Built + verified: `npx docusaurus build` produces a clean static build.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: slayerjain

docusaurus.config.js

@@ -365,11 +365,13 @@ module.exports = {
               label: "1.0.0",
               path: "1.0.0",
               banner: "unmaintained",
+              noIndex: true,
             },
             "2.0.0": {
               label: "2.0.0",
               path: "2.0.0",
               banner: "unmaintained",
+              noIndex: true,
             },
           },
           onlyIncludeVersions: ["1.0.0", "2.0.0", "4.0.0"],
@@ -464,6 +466,17 @@ module.exports = {
           //   0.5  → /docs/concepts/reference/glossary/* (long-tail
           //          glossary; noindexed legacy versions excluded via
           //          netlify headers + robots.txt)
+          //
+          // Also exclude auto-generated tag indexes and the unmaintained
+          // 1.0.0 / 2.0.0 doc versions from the sitemap. Those versions
+          // additionally carry `noIndex: true` via their `versions` config
+          // above; excluding from the sitemap signals that they should not
+          // be ranked at all.
+          ignorePatterns: [
+            "/tags/**",
+            "/1.0.0/**",
+            "/2.0.0/**",
+          ],
           createSitemapItems: async (params) => {
             const {defaultCreateSitemapItems, ...rest} = params;
             const items = await defaultCreateSitemapItems(rest);

src/components/HowTo.js

@@ -0,0 +1,113 @@
+import React from "react";
+import Head from "@docusaurus/Head";
+
+/**
+ * HowTo schema.org wrapper for Docusaurus MDX pages.
+ *
+ * Emits valid schema.org/HowTo JSON-LD into <head> and (optionally) renders a
+ * matching numbered <ol> of visible steps. Authors can pass `visible={false}`
+ * when the prose below already renders the steps so the JSON-LD is the only
+ * change to the page.
+ *
+ * Required HowTo fields per Google: name, step (array of HowToStep with name + text).
+ * Optional: totalTime (ISO 8601 duration), estimatedCost (MonetaryAmount), tool, supply.
+ *
+ * Example:
+ *   <HowTo
+ *     name="Install Keploy on Linux"
+ *     totalTime="PT5M"
+ *     estimatedCost={{currency: "USD", value: "0"}}
+ *     tools={["bash", "curl"]}
+ *     supplies={["Linux machine with kernel >= 5.10"]}
+ *     steps={[
+ *       {name: "Download", text: "Run: curl ...", url: "#download"},
+ *       {name: "Install",  text: "Run: sudo install ...", url: "#install"},
+ *     ]}
+ *     visible={false}
+ *   />
+ */
+export default function HowTo({
+  name,
+  description,
+  totalTime,
+  estimatedCost,
+  tools,
+  supplies,
+  image,
+  steps,
+  visible = true,
+}) {
+  if (!name || !Array.isArray(steps) || steps.length === 0) {
+    // Component is a no-op without the minimum required fields.
+    return null;
+  }
+
+  const schema = {
+    "@context": "https://schema.org",
+    "@type": "HowTo",
+    name,
+    step: steps.map((s, i) => {
+      const step = {
+        "@type": "HowToStep",
+        position: i + 1,
+        name: s.name || `Step ${i + 1}`,
+        text: s.text || "",
+      };
+      if (s.url) step.url = s.url;
+      if (s.image) step.image = s.image;
+      return step;
+    }),
+  };
+
+  if (description) schema.description = description;
+  if (totalTime) schema.totalTime = totalTime;
+  if (image) schema.image = image;
+  if (estimatedCost && estimatedCost.value !== undefined) {
+    schema.estimatedCost = {
+      "@type": "MonetaryAmount",
+      currency: estimatedCost.currency || "USD",
+      value: String(estimatedCost.value),
+    };
+  }
+  if (Array.isArray(tools) && tools.length > 0) {
+    schema.tool = tools.map((t) =>
+      typeof t === "string" ? {"@type": "HowToTool", name: t} : t,
+    );
+  }
+  if (Array.isArray(supplies) && supplies.length > 0) {
+    schema.supply = supplies.map((s) =>
+      typeof s === "string" ? {"@type": "HowToSupply", name: s} : s,
+    );
+  }
+
+  return (
+    <>
+      <Head>
+        <script type="application/ld+json">{JSON.stringify(schema)}</script>
+      </Head>
+      {visible && (
+        <section
+          aria-label={name}
+          style={{
+            border: "1px solid var(--ifm-color-emphasis-200)",
+            borderRadius: "12px",
+            padding: "1rem 1.25rem",
+            margin: "1rem 0 1.5rem",
+            background: "var(--ifm-background-surface-color)",
+          }}
+        >
+          <h3 style={{marginTop: 0}}>{name}</h3>
+          {description && <p>{description}</p>}
+          <ol>
+            {steps.map((s, i) => (
+              <li key={i} id={s.url && s.url.startsWith("#") ? s.url.slice(1) : undefined}>
+                <strong>{s.name || `Step ${i + 1}`}</strong>
+                {s.text && <div>{s.text}</div>}
+              </li>
+            ))}
+          </ol>
+        </section>
+      )}
+    </>
+  );
+}

src/pages/about.js

@@ -1,8 +1,44 @@
 import React from "react";
 import Layout from "@theme/Layout";
+import Head from "@docusaurus/Head";
 import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
 import useBaseUrl from "@docusaurus/useBaseUrl";
 
+// Custom React pages under src/pages/ are not covered by the docs schema
+// plugin — add Article + BreadcrumbList JSON-LD inline so the page is
+// machine-readable for search engines and AI crawlers.
+const aboutStructuredData = [
+  {
+    "@context": "https://schema.org",
+    "@type": "Article",
+    headline: "About the Keploy Documentation",
+    description:
+      "Information about Keploy's documentation, contribution guidelines, and licensing.",
+    url: "https://keploy.io/docs/about",
+    publisher: {
+      "@type": "Organization",
+      name: "Keploy",
+      logo: {
+        "@type": "ImageObject",
+        url: "https://keploy.io/docs/img/favicon.png",
+      },
+    },
+    mainEntityOfPage: {
+      "@type": "WebPage",
+      "@id": "https://keploy.io/docs/about",
+    },
+  },
+  {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    itemListElement: [
+      {"@type": "ListItem", position: 1, name: "Home", item: "https://keploy.io"},
+      {"@type": "ListItem", position: 2, name: "Docs", item: "https://keploy.io/docs"},
+      {"@type": "ListItem", position: 3, name: "About", item: "https://keploy.io/docs/about"},
+    ],
+  },
+];
+
 function About() {
   const context = useDocusaurusContext();
   const {siteConfig = {}} = context;
@@ -12,6 +48,13 @@ function About() {
       permalink="/about"
       description="User General Information about Keploy's Documentation"
     >
+      <Head>
+        {aboutStructuredData.map((schema, i) => (
+          <script key={i} type="application/ld+json">
+            {JSON.stringify(schema)}
+          </script>
+        ))}
+      </Head>
       <main className="margin-vert--lg container">
         <h1>About the docs</h1>
         <div className="margin-bottom--lg">

src/pages/concepts/reference/glossary.js

@@ -1,10 +1,47 @@
 import React, {useState, useMemo} from "react";
 import Layout from "@theme/Layout";
+import Head from "@docusaurus/Head";
 import BackToTopButton from "@theme/BackToTopButton";
 
 import {glossaryEntries} from "../../../../static/data/glossaryEntries";
 import GlossaryCard from "../../../components/GlossaryCard";
 
+// SEO/GEO: turn each glossary entry into a DefinedTerm inside a single
+// DefinedTermSet so AI engines can cite individual definitions and engines
+// can surface them as featured-snippet definitions. Mirrors the pattern in
+// landing/app/(default)/what-is-api-testing/layout.tsx.
+const allGlossaryItems = Object.values(glossaryEntries).flat();
+const SITE = "https://keploy.io";
+
+const glossaryStructuredData = [
+  {
+    "@context": "https://schema.org",
+    "@type": "DefinedTermSet",
+    "@id": `${SITE}/docs/concepts/reference/glossary#termset`,
+    name: "Keploy Software Testing Glossary",
+    description:
+      "Definitions for software testing, test automation, and quality engineering terminology, maintained by the Keploy documentation team.",
+    url: `${SITE}/docs/concepts/reference/glossary`,
+    hasDefinedTerm: allGlossaryItems.map((entry) => ({
+      "@type": "DefinedTerm",
+      name: entry.name,
+      description: entry.description,
+      url: `${SITE}${entry.link}`,
+      inDefinedTermSet: `${SITE}/docs/concepts/reference/glossary#termset`,
+    })),
+  },
+  {
+    "@context": "https://schema.org",
+    "@type": "BreadcrumbList",
+    itemListElement: [
+      {"@type": "ListItem", position: 1, name: "Home", item: SITE},
+      {"@type": "ListItem", position: 2, name: "Docs", item: `${SITE}/docs`},
+      {"@type": "ListItem", position: 3, name: "Concepts", item: `${SITE}/docs/concepts`},
+      {"@type": "ListItem", position: 4, name: "Glossary", item: `${SITE}/docs/concepts/reference/glossary`},
+    ],
+  },
+];
+
 function Glossary() {
   const [selectedletter, setselectedletter] = useState([]);
 
@@ -37,10 +74,17 @@ function Glossary() {
 
   return (
     <Layout
-      title="Glossary"
+      title="Software Testing Glossary — Keploy Documentation"
       permalink="/reference/glossary"
-      description="A glossary of terms related to software testing and development."
+      description="Definitions for software testing, test automation, and QA terminology. Acceptance, agile unit, BDD, beta, black-box testing and more."
     >
+      <Head>
+        {glossaryStructuredData.map((schema, i) => (
+          <script key={i} type="application/ld+json">
+            {JSON.stringify(schema)}
+          </script>
+        ))}
+      </Head>
       <main className="container mx-auto my-12 px-4 sm:px-6 lg:px-8">
         <div className="mb-12 text-center">
           <h1 className="text-4xl font-extrabold tracking-tight sm:text-5xl">

src/pages/index.js

@@ -62,6 +62,12 @@ export default function Home() {
           },
         }
       : null;
+  // SEO: docs landing previously rendered with title "Keploy Documentation" (20c)
+  // and meta description "API Test Generator Tool" (23c). Both were too short
+  // to capture the intent of a docs visitor (install, capture, replay, SDK).
+  const docsHomeTitle = "Keploy Documentation — Install, Capture & Replay API Tests";
+  const docsHomeDescription = "Install Keploy in 5 minutes, capture real API traffic with eBPF, and replay it as deterministic tests in CI. Quickstarts, SDK references, and integration guides.";
+
   return (
     <div className="main">
       <Head>
@@ -78,10 +84,11 @@ export default function Home() {
       </Head>
       <Layout
         className="mx-auto my-2 w-full max-w-screen-lg px-8 shadow-none"
-        title={`${siteConfig.title}`}
-        description={`${siteConfig.tagline}`}
+        title={docsHomeTitle}
+        description={docsHomeDescription}
       >
         <main className="mx-auto max-w-screen-lg p-6 md:p-10">
+          <h1 className="sr-only">{docsHomeTitle}</h1>
 
           <GetStartedPaths />
           <TestingCapabilities />

versioned_docs/version-4.0.0/quickstart/csharp-dotnet-postgres.md

@@ -18,6 +18,38 @@ keywords:
   - API Test generator
   - Auto Testcase generation
 ---
+import HowTo from '@site/src/components/HowTo';
+
+<HowTo
+  name="Sample CRUD App (CSharp) — record and replay tests with Keploy"
+  description="Clone the sample app, run it under Keploy to capture API traffic, then replay the recorded testcases."
+  totalTime="PT10M"
+  estimatedCost={{currency: "USD", value: "0"}}
+  tools={["Keploy CLI", "Docker", "git"]}
+  visible={false}
+  steps={[
+    {
+      name: "Install Keploy",
+      text: "Install the Keploy CLI on Linux/WSL using the install script from https://keploy.io/install.sh.",
+    },
+    {
+      name: "Clone the sample app",
+      text: "Clone the sample repo referenced on this page and install its dependencies.",
+    },
+    {
+      name: "Start dependencies (database, etc.)",
+      text: "Bring up any Docker services the app needs (databases, message queues) before recording.",
+    },
+    {
+      name: "Record API calls",
+      text: "Run keploy record -c \"CMD_TO_RUN_APP\" and exercise the app's endpoints (curl, Postman) to capture testcases and mocks.",
+    },
+    {
+      name: "Replay tests",
+      text: "Run keploy test -c \"CMD_TO_RUN_APP\" --delay 10 to replay the recorded testcases and detect regressions.",
+    },
+  ]}
+/>
 
 ## Running App Locally on Linux/WSL 🐧
 

versioned_docs/version-4.0.0/quickstart/express-postgresql-prisma.md

@@ -17,6 +17,38 @@ keywords:
   - API Test generator
   - Auto Testcase generation
 ---
+import HowTo from '@site/src/components/HowTo';
+
+<HowTo
+  name="Express + PostgreSQL + Prisma Sample Application — record and replay tests with Keploy"
+  description="Clone the sample app, run it under Keploy to capture API traffic, then replay the recorded testcases."
+  totalTime="PT10M"
+  estimatedCost={{currency: "USD", value: "0"}}
+  tools={["Keploy CLI", "Docker", "git"]}
+  visible={false}
+  steps={[
+    {
+      name: "Install Keploy",
+      text: "Install the Keploy CLI on Linux/WSL using the install script from https://keploy.io/install.sh.",
+    },
+    {
+      name: "Clone the sample app",
+      text: "Clone the sample repo referenced on this page and install its dependencies.",
+    },
+    {
+      name: "Start dependencies (database, etc.)",
+      text: "Bring up any Docker services the app needs (databases, message queues) before recording.",
+    },
+    {
+      name: "Record API calls",
+      text: "Run keploy record -c \"CMD_TO_RUN_APP\" and exercise the app's endpoints (curl, Postman) to capture testcases and mocks.",
+    },
+    {
+      name: "Replay tests",
+      text: "Run keploy test -c \"CMD_TO_RUN_APP\" --delay 10 to replay the recorded testcases and detect regressions.",
+    },
+  ]}
+/>
 
 import InstallReminder from '@site/src/components/InstallReminder';
 import SectionDivider from '@site/src/components/SectionDivider';