Automate `qiskit-ibm-runtime` TOC grouping
Open
Nobody has claimed this yet.
infra 🏗️
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
At the moment, we need to manually add new entries to the qiskit-ibm-runtime API TOC. This isn't really sustainable and we should look into automating it.
https://github.com/Qiskit/documentation/pull/4725#discussion_r2860300087
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 the qiskit-ibm-runtime API TOC and the discussion in Qiskit/documentation#4725, where the current manual grouping is discussed. Determine how new entries are added today; done means new API entries are grouped without manual TOC updates.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100