Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
beckykd opened this issue Apr 30, 2024 · 1 comment
Labels
API docs infra 🏗️ UI feedback rendering/layout issues with the user interface

Comments

@beckykd
Copy link
Collaborator

beckykd commented Apr 30, 2024

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

@beckykd beckykd added the UI feedback rendering/layout issues with the user interface label Apr 30, 2024
@Eric-Arellano
Copy link
Collaborator

in the current version of the API.

This is intentional to avoid duplicating the release notes for each version. We used to do this and realized it was overly complicated.

Could we possibly link it to the correct location in the Release notes?

This would be cool. I think it will look like in _toc.json for historical API versions putting the link to the release's anchor.

@Eric-Arellano Eric-Arellano changed the title Release notes should link to the correct version Release notes link to historical release for Runtime and Provider Apr 30, 2024
@Eric-Arellano Eric-Arellano changed the title Release notes link to historical release for Runtime and Provider Release notes should link to historical release headers for Runtime and Provider Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API docs infra 🏗️ UI feedback rendering/layout issues with the user interface
Projects
None yet
Development

No branches or pull requests

4 participants