Qiskit / Qiskit/documentation

Release notes should link to historical release headers for Runtime and Provider

Open
#1,262 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API docs infra 🏗️ UI feedback
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant documentation

https://docs.quantum.ibm.com/api/qiskit-ibm-runtime/release-notes

Please describe the UI problem.

If I'm looking at Qiskit Runtime .20, for example, and click Release Notes, it just opens the Release notes at the top of the page and in the current version of the API. It's pretty jarring. Could we possibly link it to the correct location in the Release notes?
image
image

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 from the Qiskit Runtime release-notes page linked in the issue and inspect how the Runtime and Provider version pages link to it. Update those links so they target the corresponding historical release headers, then verify that selecting Release Notes from an older version opens the matching section rather than the current page top.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.