Fix the Qiskit C API `objects.inv` broken links
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
The Qiskit C API has always had some broken links in the objects.inv file that we never fixed:
After the release of Qiskit v2.2.3, our link checker found roughly 320 new broken links that could be caused by our script not fully understanding the changes done in https://github.com/Qiskit/qiskit/pull/15250
To unblock the release of the docs, we ignored the objects.inv entirely from our link checker in https://github.com/Qiskit/documentation/pull/4159, so this issue is used to track fixing them.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading scripts/js/lib/links/ignores.ts around lines 423-445 and compare the link-checking behavior with the changes in Qiskit pull request 15250. Review documentation pull request 4159 to understand the temporary exclusion, then run the link checker against the Qiskit C API objects.inv. Done means the file is checked again without the broad ignore and its broken links are fixed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100