documentation icon indicating copy to clipboard operation
documentation copied to clipboard

The link checker does not extract links in the `ImageLink` component

Open arnaucasau opened this issue 8 months ago • 1 comments

The link checker is not verifying that the links used in the ImageLink component don't break. This is because we are not extracting links from any mdx components in:

https://github.com/Qiskit/documentation/blob/8650d17cb041262950542d87f13f0c4cc3f5dce9/scripts/js/lib/links/extractLinks.ts#L84-L96

arnaucasau avatar Apr 25 '25 13:04 arnaucasau

Some notes from our call:

  • Arnau tried to fix this today by updating the markdown extraction, but it dramatically slowed down the overall script.
  • There are two risks, the external links to YouTube and the links to our images.
    • We are not worried about the external link because YT is stable
    • We are somewhat worried about the image link
  • Courses will use ImageLink a bit to link to YouTube, so this becomes a little more important.
  • We want to spend <30 minutes to triage how good our error detection is currently. For example, will the pages render check catch this? From there, we can better triage

Eric-Arellano avatar Apr 25 '25 14:04 Eric-Arellano

Note that we don't use ImageLink anywhere now (replaced with embedded videos).

frankharkins avatar Jul 31 '25 11:07 frankharkins

Closing the issue as not planned because we decided to remove the ImageLink component entirely.

arnaucasau avatar Aug 08 '25 08:08 arnaucasau