Skip to content

Commit

Permalink
Update "What's new in the documentation" (#2484)
Browse files Browse the repository at this point in the history
Mid/late Oct through mid Dec updates.

---------

Co-authored-by: Eric Arellano <[email protected]>
Co-authored-by: Rebecca Dimock <[email protected]>
Co-authored-by: Arnau Casau <[email protected]>
  • Loading branch information
4 people authored Dec 17, 2024
1 parent a882131 commit 1498820
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 29 deletions.
65 changes: 36 additions & 29 deletions docs/guides/latest-updates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ description: The latest updates from Qiskit and IBM Quantum, including the lates

# Latest updates

*Last updated 4 December 2024*
*Last updated 17 December 2024*
{/* remember to update the date in the previous line each time this page is updated!!! */}

Keep up with the latest and greatest from Qiskit and IBM Quantum&trade;! Gathered here are the the most recent Qiskit package release summaries, documentation updates, blogs, community events, and more.
Keep up with the latest and greatest from Qiskit and IBM Quantum&trade;! Gathered here are the most recent Qiskit package release summaries, documentation updates, blogs, community events, and more.

## Latest release summaries

Expand Down Expand Up @@ -146,50 +146,57 @@ IBM Quantum documentation recently added a number of user-facing improvements, i

**New pages**

New pages include documentation for [Qiskit Functions](/guides/functions), [Qiskit addons](/guides/addons), and [Qiskit Code Assistant](/guides/qiskit-code-assistant), as well as a guide about [job limits](/guides/job-limits).
Visit the newest content in the documentation!

- Qiskit Functions [Introduction](/guides/functions)
- [IBM&reg; Circuit function](/guides/ibm-circuit-function)
- [Algorithmiq TEM function](/guides/algorithmiq-tem)
- [Q-CTRL Performance Management](/guides/q-ctrl-performance-management)
- [Qedma QESEM](/guides/qedma-qesem)
- [Q-CTRL Optimization Solver](/guides/q-ctrl-optimization-solver)
- [QunaSys QURI Chemistry](/guides/qunasys-quri-chemistry)
- Qiskit Code Assistant [Overview](/guides/qiskit-code-assistant)
- [Use Qiskit Code Assistant in JupyterLab](/guides/qiskit-code-assistant-jupyterlab)
- [Use Qiskit Code Assistant in Visual Studio Code](/guides/qiskit-code-assistant-vscode)
- Introductory and get-started material for these [Qiskit addons](/guides/addons):
- [Sample-based quantum diagonalization (SQD)](/guides/qiskit-addons-sqd)
- [Approximate quantum compiler with tensor networks (AQC-Tensor)](/guides/qiskit-addons-aqc)
- [Operator backpropagation (OBP)](/guides/qiskit-addons-obp)
- [Multi-product formulas (MPF)](/guides/qiskit-addons-mpf)

**Content additions and improvements**
- [Debug Qiskit Runtime jobs](/guides/debug-qiskit-runtime-jobs) with the NEAT class

- [Integrate external quantum resources with Qiskit](/open-source/create-a-provider) guide in Open-source resources

- New migration guide: [Migrate from Qiskit Pulse to fractional gates](/migration-guides/pulse-migration)

- Added content to the [Execution modes](/guides/execution-modes) guides and improved explanatory content in the [Introduction to primitives](/guides/primitives) page
- New Qiskit Functions guide: [Singularity Machine Learning - Classification](/guides/multiverse-computing-singularity)

- Clarified how the [Estimator primitive calculates error](/guides/primitive-input-output#how-the-estimator-calculates-error)
- [Use Qiskit Code Assistant in local mode](/guides/qiskit-code-assistant-local)

**Content additions and improvements**

- A new [FAQ](/faq) page
- Guidance on how to [securely manage your API token](/guides/setup-channel#set-up-to-use-ibm-quantum-platform), as part of the guide to set up an IBM Quantum channel

- Improvements to the [Support](/support) page
- Revisions by Qunasys to the Qiskit Functions [QURI Chemistry](/guides/qunasys-quri-chemistry) guide

- Some error codes now link out to relevant documentation ([example](/errors#8055))
- Updated code examples to fix a bug in [Get started with primitives](/guides/get-started-with-primitives)

- Information about [benchmarking and the Benchpress package](/guides#benchmarking-and-the-benchpress-package)
- Updates to [Introduction to options](/guides/runtime-options-overview) to include the new [gen3-turbo](/guides/runtime-options-overview#experimental-option-note) options

- Copyediting and typo fixes across the documentation, including bugs reported by open-source contributors - thank you!

**New API reference documentation**
### New API reference documentation

- [qiskit-ibm-runtime 0.29-0.31](/api/qiskit-ibm-runtime/release-notes)
- [qiskit-ibm-transpiler 0.7](/api/qiskit-ibm-transpiler/release-notes)
- [Qiskit SDK v1.3](/api/qiskit/release-notes)
- [qiskit-ibm-runtime v0.32-0.34](/api/qiskit-ibm-runtime/release-notes)
- [qiskit-ibm-transpiler v0.8-0.9](/api/qiskit-ibm-transpiler/release-notes)
- Qiskit addons:
- [qiskit-addon-aqc-tensor](/api/qiskit-addon-aqc-tensor/release-notes)
- [qiskit-addon-cutting](/api/qiskit-addon-cutting/release-notes)
- [qiskit-addon-obp](/api/qiskit-addon-obp/release-notes)
- [qiskit-addon-mpf](/api/qiskit-addon-mpf/release-notes)
- [qiskit-addon-sqd](/api/qiskit-addon-sqd/release-notes)
- [qiskit-addon-utils](/api/qiskit-addon-utils/release-notes)

### 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](/api/qiskit-ibm-transpiler).
- Code blocks that write to a file now display the file path; see examples in this [Qiskit Serverless guide](/guides/serverless-first-program).
- Tips to use the Qiskit Code Assistant now appear throughout the guides.
- The required versions of packages used in code examples are now listed at the top of each guide.
- Bug in menu view on mobile devices is now fixed.
- Search bar is now bigger for increased discoverability, and your search query is preserved after you close the search modal.
- All code examples have been updated to work with Qiskit SDK v1.3 and Qiskit Runtime v0.34

*A huge thank you goes out to everyone in the open-source community who contributed and gave feedback!* Please [open an issue](https://github.com/Qiskit/documentation/issues/new/choose) if you find a bug, have a suggestion, or want to share your experience.

Expand Down
1 change: 1 addition & 0 deletions scripts/config/cspell/dictionaries/qiskit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ qsphere
qubit
qubits
qudit
Qunasys
qutrit
quimb
randomizations
Expand Down

0 comments on commit 1498820

Please sign in to comment.