Extend the link checker to validate the Qiskit C API historical versions & fix its ignored links
Open
Nobody has claimed this yet.
infra 🏗️
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
Currently, our link checker is not checking historical versions of the Qiskit C API. We need to extend our script to validate them by adding a new entry to:
Moreover, we have some ignored links that we should fix. See:
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 in scripts/js/commands/checkInternalLinks.ts around line 187 to understand how API versions are registered, then inspect scripts/js/lib/links/ignores.ts around lines 420-453. Add the Qiskit C API historical-version entry and resolve the ignored links, then run the link checker to confirm those versions and links validate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100