What's new in the docs?
IBM Quantum™ documentation recently added several user-facing improvements, including content updates and new features. Many of these changes are a result of specific user requests! Check out the highlights below.
Updated content
New pages
New pages include documentation for Qiskit Functions, Qiskit addons, and Qiskit Code Assistant, as well as a guide about job limits.
- Qiskit Functions Introduction
- IBM® Circuit function
- Algorithmiq TEM function
- Q-CTRL Performance Management
- Qedma QESEM
- Q-CTRL Optimization Solver
- QunaSys QURI Chemistry
- Qiskit Code Assistant Overview
- Use Qiskit Code Assistant in JupyterLab
- Use Qiskit Code Assistant in Visual Studio Code
Content additions and improvements
-
Added content to the Execution modes guides and improved explanatory content in the Introduction to primitives page
-
Clarified how the Estimator primitive calculates error
-
A new FAQ page
-
Improvements to the Support page
-
Some error codes now link out to relevant documentation (example)
-
Information about benchmarking and the Benchpress package
-
Copyediting and typo fixes across the documentation, including bugs reported by open-source contributors - thank you!
New API reference documentation
User experience improvements
Updates to the infrastructure and design of the documentation include the following:
- We fixed GitHub source code links for functions using decorators - thanks to the open-source contributor who opened an issue for this!
- When you change the version in the left sidebar of the API reference docs, you arrive at the equivalent page in the new version. If the page does not exist in the new version, you land on the index page.
- We improved the design and color of the warning banner for when you access outdated API pages to make it more obvious that newer docs are available. The banner persists as you scroll down the page.
- Source code links and release notes have been added to the Qiskit Transpiler Service Client API documentation.
- Code blocks that write to a file now display the file path; see examples in this Qiskit Serverless guide.
- Tips to use the Qiskit Code Assistant now appear throughout the guides.
A huge thank you goes out to everyone in the open-source community who contributed and gave feedback! Please open an issue if you find a bug, have a suggestion, or want to share your experience.