Audited and improved existing metadata for main docs pages (Qiskit#345)

closes Qiskit#131 --------- Co-authored-by: abbycross <[email protected]>
frankharkins · Nov 16, 2023 · 7979513 · 7979513
1 parent 60aee51
commit 7979513
Show file tree

Hide file tree

Showing 20 changed files with 21 additions and 21 deletions.
diff --git a/docs/build/circuit-library.ipynb b/docs/build/circuit-library.ipynb
@@ -429,8 +429,8 @@
   }
  ],
  "metadata": {
-  "title": "What is the circuit library?",
-  "description": "Qiskit includes a collection of popular quantum circuits so you don't need to code them yourself. Read more about the different types of circuits provided.",
+  "title": "Circuit library",
+  "description": "Read more about out-of-the-box circuits provided by the Qiskit circuit library, including N-local, time-evolution and data-encoding circuits",
   "kernelspec": {
    "display_name": "Python 3",
    "language": "python",

diff --git a/docs/build/circuit-visualization.ipynb b/docs/build/circuit-visualization.ipynb
@@ -1301,7 +1301,7 @@
  "metadata": {
   "anaconda-cloud": {},
   "celltoolbar": "Tags",
-  "description": "Plotting data in Qiskit notebook",
+  "description": "Create visualizations of circuits and plot job data using the Qiskit visualization module ",
   "kernelspec": {
    "display_name": "Python 3.10.6 64-bit ('quantum')",
    "language": "python",

diff --git a/docs/build/classical-feedforward-and-control-flow.ipynb b/docs/build/classical-feedforward-and-control-flow.ipynb
@@ -341,7 +341,7 @@
   }
  ],
  "metadata": {
-  "description": "How-to guide on classical feedforward and control flow",
+  "description": "Use Qiskit for classical feedforward and control flow, otherwise referred to as dynamic circuits",
   "kernelspec": {
    "display_name": "documentation--fuetTj0",
    "language": "python",

diff --git a/docs/build/index.mdx b/docs/build/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Introduction
-description: Build circuits with Qiskit and Qiskit Runtime
+description: Build quantum programs using Qiskit quantum circuits, operators, waveform pulses, or OpenQASM.
 
 ---
 

diff --git a/docs/build/operators-overview.ipynb b/docs/build/operators-overview.ipynb
@@ -1173,7 +1173,7 @@
  "metadata": {
   "anaconda-cloud": {},
   "celltoolbar": "Tags",
-  "description": "Operators notebook",
+  "description": "Use the Qiskit quantum information module to construct and manipulate operators",
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/docs/build/pulse.ipynb b/docs/build/pulse.ipynb
@@ -1060,7 +1060,7 @@
   }
  ],
  "metadata": {
-  "description": "Pulse schedules",
+  "description": "Learn low-level pulse waveform programming using the Qiskit pulse module",
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/docs/run/account-management.mdx b/docs/run/account-management.mdx
@@ -1,6 +1,6 @@
 ---
 title: Manage your account
-description: Manage your account
+description: Manage your IBM Quantum Platform or IBM Quantum Cloud account
 ---
 # Manage your account
 

diff --git a/docs/run/advanced-runtime-options.mdx b/docs/run/advanced-runtime-options.mdx
@@ -1,6 +1,6 @@
 ---
 title: Advanced runtime options
-description: Specify options when building with primitives 
+description: Specify options when building with Qiskit runtime primitives 
 
 ---
 

diff --git a/docs/run/configure-error-mitigation.mdx b/docs/run/configure-error-mitigation.mdx
@@ -1,6 +1,6 @@
 ---
 title: Configure error mitigation
-description: Configure error mitigation
+description: Configure error mitigation with Qiskit Runtime
 ---
 
 # Configure error mitigation for Qiskit Runtime

diff --git a/docs/run/get-backend-information.ipynb b/docs/run/get-backend-information.ipynb
@@ -333,7 +333,7 @@
   }
  ],
  "metadata": {
-  "description": "Get backend information with Qiskit notebook, including view backend information, configuration, properties, list and filter backends, and find backend information from other channels",
+  "description": "Learn how to get backend information with Qiskit, including view backend information, configuration, properties, list and filter backends, and find backend information from other channels",
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/docs/run/instances.mdx b/docs/run/instances.mdx
@@ -1,6 +1,6 @@
 ---
 title: Instances
-description: What instances are and how to use them
+description: What IBM Quantum Platform instances are and how to use them
 ---
 # Instances
 

diff --git a/docs/run/primitives-get-started.mdx b/docs/run/primitives-get-started.mdx
@@ -1,6 +1,6 @@
 ---
 title: Get started with primitives
-description: Use Estimator and Sampler
+description: Use Qiskit Runtime Estimator and Sampler
 
 ---
 

diff --git a/docs/run/sessions.mdx b/docs/run/sessions.mdx
@@ -1,6 +1,6 @@
 ---
 title: Sessions
-description: Describes what sessions are. 
+description: An overview of sessions and when to use them. 
 
 ---
 

diff --git a/docs/start/hello-world.ipynb b/docs/start/hello-world.ipynb
@@ -276,7 +276,7 @@
  ],
  "metadata": {
   "celltoolbar": "Raw Cell Format",
-  "description": "Hello world notebook",
+  "description": "Get started using Qiskit with IBM Quantum hardware in this Hello World example",
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/docs/start/index.mdx b/docs/start/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: Introduction
-description: Introduction to IBM Quantum documentation and API reference
+description: Introduction to IBM Quantum documentation
 
 in_page_toc_max_heading_level: 2
 

diff --git a/docs/start/install-qiskit-source.mdx b/docs/start/install-qiskit-source.mdx
@@ -1,6 +1,6 @@
 ---
 title: Install Qiskit from source
-description: Install Qiskit from source
+description: Learn how to install the development version of Qiskit.
 
 ---
 # Install Qiskit from source

diff --git a/docs/start/setup-channel.mdx b/docs/start/setup-channel.mdx
@@ -1,6 +1,6 @@
 ---
 title: Select and set up an IBM Quantum channel
-description: Install and set up IBM Quantum Platform or IBM Quantum on IBM Cloud to submit Qiskit and Qiskit Runtime jobs
+description: Installation and setup instructions for IBM Quantum Platform or IBM Quantum on IBM Cloud to submit Qiskit and Qiskit Runtime jobs
 
 ---
 # Select and set up an IBM Quantum channel

diff --git a/docs/verify/building_noise_models.ipynb b/docs/verify/building_noise_models.ipynb
@@ -874,7 +874,7 @@
     }
   ],
   "metadata": {
-    "description": "Building noise models",
+    "description": "Build custom noise models for noisy simulation with Qiskit Aer",
     "kernelspec": {
       "display_name": "Python 3",
       "language": "python",

diff --git a/docs/verify/simulate-with-qiskit-aer.ipynb b/docs/verify/simulate-with-qiskit-aer.ipynb
@@ -232,7 +232,7 @@
   }
  ],
  "metadata": {
-  "description": "Article on exact and noisy simulation with Qiskit Aer primitives",
+  "description": "Learn how to do exact and noisy simulation of quantum programs with Qiskit Aer primitives",
   "kernelspec": {
    "display_name": "documentation--fuetTj0",
    "language": "python",

diff --git a/docs/verify/stabilizer-circuit-simulation.ipynb b/docs/verify/stabilizer-circuit-simulation.ipynb
@@ -186,7 +186,7 @@
   }
  ],
  "metadata": {
-  "description": "Article on efficient simulation of stabilizer circuits with Qiskit Aer primitives",
+  "description": "Efficient simulation of stabilizer circuits with Qiskit Aer primitives",
   "kernelspec": {
    "display_name": "documentation--fuetTj0",
    "language": "python",