Qiskit / Qiskit/documentation

ImageMagick AVIF instructions were lost

Open
#3,582 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄 infra 🏗️
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

We used to have instructions about how to use AVIF, but I can't find them anymore:

https://github.com/Qiskit/documentation/blob/1eb5fef5fd3de3615dd0000e796ccc5fcd9fa59e/scripts/js/commands/checkImages.ts#L56

See if we can recover those by looking at Git history. Or, rewrite from scratch. They should probably live in the mdx-guide.md in the Images section.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the referenced history of scripts/js/commands/checkImages.ts and search Git history for the removed AVIF instructions. Then inspect mdx-guide.md, especially its Images section, to determine where the recovered or rewritten guidance belongs. Done means the guide again explains how to use AVIF with ImageMagick.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.