Qiskit / Qiskit/documentation

Consider removing the patch version from the version selector

Open
#4,888 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API docs design 🎨 infra 🏗️ needs triage 🤔
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

URL to the relevant guide or resource

https://quantum.cloud.ibm.com/docs/en/api/* like https://quantum.cloud.ibm.com/docs/en/api/qiskit-ibm-runtime and https://quantum.cloud.ibm.com/docs/en/api/qiskit/

Select all that apply
  • new content request
  • typo
  • code bug
  • out-of-date content
  • broken link
  • other
Describe the fix or the content request.

The version selector shows (correctly) the last patch version of each minor release without showing the old patch versions (for example, v2.3.1 is there, but v2.3.0 is not there). This selector points to a URL without the patch version (for example, v2.3.1 points to quantum.cloud.ibm.com/docs/en/api/qiskit/2.3/...). Since the numbers between the dots in the versions are currently similar, I often have to think twice before selecting the right option.

I think it would be great if the patch version were not shown in the selector (i.e., v2.3 instead of v2.3.1). The patch version provides no extra information and clutters the selector a bit.

For new content requests - if the request is accepted, do you want to write the content?

(No answer)

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 opening the API documentation URLs in the issue and tracing where the version selector is configured or rendered. Update the selector so each minor release is labeled without its patch number, while confirming its links still resolve to the corresponding versioned documentation URLs.

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
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.