Skip to content

Organize Documentation Examples  #1624

Description

@efratshabtai

Required prerequisites

  • Search the issue tracker to check if your feature has already been mentioned or rejected in other issues.

Describe the feature

Some of the pages under the CUDA-Q Applications folder need to be organized and move to new locations:

  1. The Quantum Bits and Multiple Qubits pages need to be merged to one page starting with the content of the former and ending in the latter. The new page will be called 'Quantum Operations' and needs to be moved under Examples, right after the Introduction page.
  2. The Multi-GPU Workflows page Needs to move under Examples folder, right after Multi-Control Synthesis.
  3. Executing Quantum Circuits should be merged with the 'Sample' and 'Observe' content in Running your first CUDA-Q Program page under Basics.

Please note:

  • The pages under the Applications folder were created from Jupyter notebooks while pages under Examples and Basics are generated from another format. Therefore, moving pages between these folders will require a format change of the original content. Specifically, a new .rst file needs to be created here, and the code cells need to be moved into separate Python/C++ files either under snippets (for small code blocks) or under examples (for larger, more interesting code examples). To see how these code blocks are included in the rst file, take a look e.g. at introduction.rst.

  • The content needs to be clear and helpful to all CUDA-Q users, so feel free to bring your own point of view.

Metadata

Metadata

Assignees

Labels

UnitaryHackGood issue for UnitaryHack

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions