Audit courses to link to API docs
Open
Nobody has claimed this yet.
content 📄
course 🎓
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
For example, the new QML course has this:
the built-in feature mappings in Qiskit (like ZFeatureMap and ZZFeatureMap)
It'd be great to link to the API docs by using /docs/api/qiskit/my-page.
We should audit all our courses.
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 locating the new QML course and reviewing how feature mappings such as ZFeatureMap and ZZFeatureMap are referenced. Audit the courses for similar references and link them to the corresponding API documentation using the stated URL pattern; done means all applicable course references have API links.
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
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100