Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Organize Documentation Examples #1624

Open
1 task done
efratshabtai opened this issue May 7, 2024 · 0 comments · May be fixed by #1724
Open
1 task done

Organize Documentation Examples #1624

efratshabtai opened this issue May 7, 2024 · 0 comments · May be fixed by #1724
Labels
UnitaryHack Good issue for UnitaryHack

Comments

@efratshabtai
Copy link
Collaborator

efratshabtai commented May 7, 2024

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.

@efratshabtai efratshabtai added enhancement New feature or request UnitaryHack Good issue for UnitaryHack labels May 7, 2024
@bettinaheim bettinaheim removed the enhancement New feature or request label May 8, 2024
@WingCode WingCode linked a pull request May 29, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
UnitaryHack Good issue for UnitaryHack
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants