Skip to content

Improve the metadata for each page #131

Closed
@Eric-Arellano

Description

@Eric-Arellano

Specifically the title and description. We want better SEO and social media sharing.

In MDX, this is at the top of the file:

---
title: Getting help
description: How to find answers to questions or problems you encounter while using IBM Quantum (Platform, or on IBM Cloud) or Qiskit Runtime

In notebooks, it's in the file's metadata section, which is much easier to miss:

"title": "Conditional reset",
"description": "Conditional reset"

The title is used for the browser tab's title and for the SEO and social media title. Description is used for SEO and social media. Best practices to follow for the description:

  • No more than 160 characters
  • Contains relevant keywords to the page, especially keywords developers might be looking for.
    • But also keyword stuffing negatively impacts SEO, like Hadamon Gate, quantum computing, Qiskit, Runtime, transpile is a bad description. It should read naturally. Reminder the description is used for rich previews on social media & the Google result.
  • Unique per page. That's helpful for our end users too when they are looking in the search results on what page they want.
  • Think about what is engaging for our users to want to open the link when they're on Google and social media. It's not only about Google showing our result up top; it's also that people want to click it.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions