Metadata missing for one Qiskit SDK API file
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
These never had front matter. Axel said it's fine for now, but we should improve it soon.
Please fix these files: docs/api/qiskit-ibm-provider/ibm-provider.md,docs/api/qiskit/transpiler_builtin_plugins.md,docs/api/qiskit-ibm-runtime/ibm-runtime.md
We need to an else clause here:
TBD how we determine the title and description!
Update: make sure CI enforces it, per https://github.com/Qiskit/documentation/issues/793.
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 with scripts/lib/sphinx/addFrontMatter.ts at the linked lines and inspect the three listed files: docs/api/qiskit-ibm-provider/ibm-provider.md, docs/api/qiskit/transpiler_builtin_plugins.md, and docs/api/qiskit-ibm-runtime/ibm-runtime.md. Resolve how their title and description should be determined, add the missing front matter, and update CI so these files remain covered as requested in issue 793.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, typescript
- Domain
- build-system, ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100