Separate addons into sections by kaelynj · Pull Request #4965 · Qiskit/documentation

kaelynj · 2026-04-09T20:32:05Z

qiskit-bot · 2026-04-09T20:32:09Z

One or more of the following people are relevant to this code:

@jenglick
@pandasa123
@beckykd

abbycross · 2026-04-10T13:40:19Z

The first h2 starts with "Addons for" and the rest of the h2s don't follow that pattern. Style guide has us avoid gerunds in headers, so I would recommend a structure like this:

Addons to map domain problems

Addons to optimize circuits for hardware execution

Addons to manage noise for expectation value estimation

Addons to manage noise for sampling results

Supplemental addons

Alternative: just remove the "Addons to" altogether, if it feels too repetitive... and go with:

Map domain problems

Optimize circuits for hardware execution

Manage noise for expectation value estimation
etc.

I like the alternative option (removing addons from those headers)

abbycross · 2026-04-10T13:43:56Z


+
+## Addons for mapping domain problems
+These addons are particularly useful for preparing efficient quantum circuits based on the application you are building for.


Suggested change

These addons are particularly useful for preparing efficient quantum circuits based on the application you are building for.

These addons are particularly useful for preparing efficient quantum circuits based on the application you are building.

"based on the application" - Maybe this can be clearer - are the circuits based on the application, or are the addons based on the application?

abbycross · 2026-04-10T13:49:03Z

+

+## Optimizing circuits for hardware execution
+The following addons are useful for reducing circuit depth, both generally (for the circuit cutting addon) and when your workload estimates the expectation value of an observable using operator backpropagation.


The phrase "addons are useful for" is repeated in each section. It's more concise to use language like
"Use the following addons to reduce circuit depth, both generally..." (and I think it will feel less obviously repetitive, even if you use it in every section).

Or - mix it up with language like "These addons excel at...." "The purpose of these addons is..." "These addons specialize in..." etc.

Good suggestion (I would perhaps replace addons with capabilities). I like both "Use these capabilities to ..." and "These capabilities specialize in..."

abbycross · 2026-04-10T13:49:12Z

+</CardGroup>

+## Noise management for expectation value estimation
+These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.


Suggested change

These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.

These addons are useful for managing noise when building quantum workloads that estimate expectation values of one or more observables.

I think we could be more concise and just say "expectation values of observables"

…orize-addons

jenglick

@kaelynj thank you! Some minor edits to start with

jenglick · 2026-04-10T16:15:46Z

I like the alternative option (removing addons from those headers)

jenglick · 2026-04-10T16:16:50Z

@@ -9,6 +9,9 @@ description: Understand the Qiskit addon tools, which help you build utility-gra

 Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms. Many of these addons are powered by the `qiskit-addon-utils` package. See the [Qiskit addon utilities documentation](https://qiskit.github.io/qiskit-addon-utils/) for more information.


Let's remove the last two sentences on the utils package since we now have a dedicated section for it.

jenglick · 2026-04-10T16:17:50Z

Let's move the optimization mapper to the top of the list. And add the qiskit-fermions package next to it. Suggested description for the latter: "Map fermionic problems to qubit operators and circuits."

jenglick · 2026-04-10T20:23:32Z

+</CardGroup>

+## Noise management for expectation value estimation
+These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.


I think we could be more concise and just say "expectation values of observables"

jenglick · 2026-04-10T20:25:25Z

    />
 </CardGroup>

+## Supplemental addons


I like where you're going with this. What about

Suggested change

## Supplemental addons

## Supplemental capabilities

or

Suggested change

## Supplemental addons

## Supporting capabilities

I think I prefer "supporting capabilities" the most here

jenglick · 2026-04-10T20:34:53Z

+

+## Optimizing circuits for hardware execution
+The following addons are useful for reducing circuit depth, both generally (for the circuit cutting addon) and when your workload estimates the expectation value of an observable using operator backpropagation.


Good suggestion (I would perhaps replace addons with capabilities). I like both "Use these capabilities to ..." and "These capabilities specialize in..."

jenglick

A few more quick comments!

jenglick · 2026-04-10T21:09:06Z

+</CardGroup>

+## Noise management for sampling results
+These addons are useful for managing noise when building sample-based quantum workloads.


I want to add a card here for the postselection capabilities in addon-utils. Even though we call out the addon-utils package later on, I think it's worth highlighting the postselection tools for mitigation

jenglick · 2026-04-10T21:12:12Z

+</CardGroup>

+## Noise management for sampling results
+These addons are useful for managing noise when building sample-based quantum workloads.


Let's remove the dice-eigensolver card and organize the tiles in this section in this order:
first row: sqd, sqd-hpc
second row: postselection, mthree

Co-authored-by: abbycross <across@us.ibm.com> Co-authored-by: Jen Glick <41485571+jenglick@users.noreply.github.com>

kaelynj · 2026-04-15T18:57:04Z

Thanks for the edits @jenglick! Just finished going through them and implementing the changes. Let me know if there's anything else we should change.

abbycross · 2026-04-15T19:27:57Z

+These capabilities specialize in mapping domain problems into quantum operators and circuits for execution on a quantum computer.
 <CardGroup>
+    <Card
+      title="Optimization Mapper"


Suggested change

title="Optimization Mapper"

title="Optimization mapper"

Whoops, I thought this one's official name was capital-M Mapper, but I just now checked and it's not. (AQC-Tensor is officially capital-T Tensor... I mixed them up)

jenglick

A few more quick comments

jenglick · 2026-04-15T21:23:46Z

+</CardGroup>
+
+## Manage noise for sampling results
+Manage noise when sampling results with the following addons.


Suggested change

Manage noise when sampling results with the following addons.

These techniques are useful for managing noise on sampling results.

jenglick · 2026-04-15T21:26:00Z

+</CardGroup>
+
+## Supplemental addons
+This set of functions can be used to support and compose your workflows that leverage other addons.


Suggested change

This set of functions can be used to support and compose your workflows that leverage other addons.

Use these capabilities to support and compose your workflows that leverage other addons.

jenglick · 2026-04-15T21:38:39Z

 # Advanced techniques - Qiskit addons

-Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms. Many of these addons are powered by the `qiskit-addon-utils` package. See the [Qiskit addon utilities documentation](https://qiskit.github.io/qiskit-addon-utils/) for more information.
+Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components build upon Qiskit’s performant foundation and can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms.


I think it would be helpful to add a final sentence here that says what this page does. Something like this

Suggested change

Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components build upon Qiskit’s performant foundation and can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms.

Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components build upon Qiskit’s performant foundation and can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms. This page highlights the available tools across key functional categories to help you choose relevant capabilities when building your workflows.

Separate addons into sections

ab646da

github-project-automation bot added this to Docs Planning Apr 9, 2026

kaelynj requested review from a team and jenglick April 9, 2026 20:32

github-actions bot had a problem deploying to pr_preview April 9, 2026 20:32 Failure

abbycross reviewed Apr 10, 2026

View reviewed changes

Comment thread docs/guides/addons.mdx Outdated

github-actions bot deployed to pr_preview April 10, 2026 13:59 View deployment

Merge branch 'main' of github.com:Qiskit/documentation into kjf/categ…

1c36be8

…orize-addons

github-actions bot deployed to pr_preview April 10, 2026 18:35 View deployment

jenglick reviewed Apr 10, 2026

View reviewed changes

Apply suggestions from code review

31239c0

Co-authored-by: abbycross <across@us.ibm.com> Co-authored-by: Jen Glick <41485571+jenglick@users.noreply.github.com>

github-actions bot deployed to pr_preview April 13, 2026 13:30 View deployment

Implement review suggestions

5b8ce2c

github-actions bot deployed to pr_preview April 15, 2026 18:56 View deployment

abbycross reviewed Apr 15, 2026

View reviewed changes

jenglick reviewed Apr 15, 2026

View reviewed changes



		## Addons for mapping domain problems
		These addons are particularly useful for preparing efficient quantum circuits based on the application you are building for.



		## Optimizing circuits for hardware execution
		The following addons are useful for reducing circuit depth, both generally (for the circuit cutting addon) and when your workload estimates the expectation value of an observable using operator backpropagation.

	These addons are useful for managing noise when building quantum workloads which estimate expectation values of one or more observables.
	These addons are useful for managing noise when building quantum workloads that estimate expectation values of one or more observables.

		@@ -9,6 +9,9 @@ description: Understand the Qiskit addon tools, which help you build utility-gra

		Qiskit addons are a collection of research capabilities for enabling algorithm discovery at the utility scale. These modular software components can plug into a [workflow](/docs/guides/intro-to-patterns) to scale or design new quantum algorithms. Many of these addons are powered by the `qiskit-addon-utils` package. See the [Qiskit addon utilities documentation](https://qiskit.github.io/qiskit-addon-utils/) for more information.

	Manage noise when sampling results with the following addons.
	These techniques are useful for managing noise on sampling results.

	This set of functions can be used to support and compose your workflows that leverage other addons.
	Use these capabilities to support and compose your workflows that leverage other addons.

Conversation

kaelynj commented Apr 9, 2026

Uh oh!

qiskit-bot commented Apr 9, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jenglick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jenglick left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenglick Apr 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaelynj commented Apr 15, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenglick left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jenglick Apr 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jenglick Apr 10, 2026 •

edited

Loading

jenglick Apr 15, 2026 •

edited

Loading