Audit long tooltips for possible conversion to other formats
Open
Nobody has claimed this yet.
content 📄
on hold ⏸️
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
As a follow-on to https://github.com/Qiskit/documentation/issues/3734, and once https://github.com/Qiskit/documentation/pull/3892 is finished, review any long tooltips that might make more sense as a new paragraph, admonition box, figure, etc.
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 issue #3734 and checking the status of pull request #3892, then search the documentation for long tooltips. Review each candidate to decide whether a paragraph, admonition box, figure, or another format communicates it better. Done means the relevant tooltips have been audited and appropriate conversions are identified.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100