Add missing metadata for Qiskit Transpiler Service (#1438)

Qiskit · May 28, 2024 · 2e59764 · 2e59764
1 parent 5a58268
commit 2e59764
Show file tree

Hide file tree

Showing 13 changed files with 31 additions and 12 deletions.
diff --git a/docs/api/qiskit-ibm-runtime/0.14/index.mdx b/docs/api/qiskit-ibm-runtime/0.14/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.15/index.mdx b/docs/api/qiskit-ibm-runtime/0.15/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.16/index.mdx b/docs/api/qiskit-ibm-runtime/0.16/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.17/index.mdx b/docs/api/qiskit-ibm-runtime/0.17/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.18/index.mdx b/docs/api/qiskit-ibm-runtime/0.18/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.19/index.mdx b/docs/api/qiskit-ibm-runtime/0.19/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.20/index.mdx b/docs/api/qiskit-ibm-runtime/0.20/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.21/index.mdx b/docs/api/qiskit-ibm-runtime/0.21/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/0.22/index.mdx b/docs/api/qiskit-ibm-runtime/0.22/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/dev/index.mdx b/docs/api/qiskit-ibm-runtime/dev/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-ibm-runtime/index.mdx b/docs/api/qiskit-ibm-runtime/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime
+description: API documentation for the qiskit-ibm-runtime client
 ---
 
 # qiskit-ibm-runtime API reference

diff --git a/docs/api/qiskit-transpiler-service/index.mdx b/docs/api/qiskit-transpiler-service/index.mdx
@@ -1,5 +1,11 @@
+---
+title: Qiskit Transpiler Service Client Docs
+description: API documentation for the qiskit-transpiler-service client
+---
+
 # qiskit-transpiler-service API reference
 
 *   [AI (`qiskit_transpiler_service.ai`)](ai)
 *   [Qiskit Transpiler Service (`qiskit_transpiler_service.transpiler_service`)](transpiler_service)
 *   [Utilities (`qiskit_transpiler_service.utils`)](utils)
+
diff --git a/scripts/lib/api/specialCaseResults.ts b/scripts/lib/api/specialCaseResults.ts
@@ -13,11 +13,14 @@
 import { HtmlToMdResultWithUrl } from "./HtmlToMdResult";
 
 export const RUNTIME_INDEX_META = `title: Qiskit Runtime IBM Client API Docs
-description: API documentation for qiskit-ibm-runtime`;
+description: API documentation for the qiskit-ibm-runtime client`;
 
 export const PROVIDER_INDEX_META = `title: Qiskit IBM Provider API Docs
 description: API documentation for qiskit-ibm-provider`;
 
+export const TRANSPILER_SERVICE_INDEX_META = `title: Qiskit Transpiler Service Client Docs
+description: API documentation for the qiskit-transpiler-service client`;
+
 export function transformSpecialCaseUrl(url: string): string {
   return (
     url
@@ -46,6 +49,16 @@ export function specialCaseResults(results: HtmlToMdResultWithUrl[]): void {
         hardcodedFrontmatter: RUNTIME_INDEX_META,
       };
     }
+
+    if (
+      result.url.endsWith("/index") &&
+      result.url.includes("qiskit-transpiler-service/")
+    ) {
+      result.meta = {
+        hardcodedFrontmatter: TRANSPILER_SERVICE_INDEX_META,
+      };
+    }
+
     result.url = transformSpecialCaseUrl(result.url);
   }
 }