KEMBAR78
Improve structure and clarity of the documentation by WingCode · Pull Request #1724 · NVIDIA/cuda-quantum · GitHub
Skip to content

Improve structure and clarity of the documentation #1724

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 41 commits into from
Jun 20, 2024
Merged

Improve structure and clarity of the documentation #1724

merged 41 commits into from
Jun 20, 2024

Conversation

@WingCode
Copy link
Contributor

Description

closes #1624

@copy-pr-bot
Copy link

copy-pr-bot bot commented May 29, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions
Copy link

github-actions bot commented May 29, 2024 •
edited
Loading

CLA Assistant Lite bot All Contributors have signed the CLA.

@WingCode
Copy link
Contributor Author

WingCode commented May 29, 2024 •
edited
Loading

I have read the Contributor License Agreement and I hereby accept the Terms.

@WingCode
Copy link
Contributor Author

recheck

cuda-quantum-bot added a commit that referenced this pull request May 29, 2024
@cuda-quantum-bot
@WingCode has signed the CLA from Pull Request #1724
5ba95fa
@efratshabtai
Copy link
Collaborator

efratshabtai commented Jun 3, 2024 •
edited
Loading

Thank you for the PR @WingCode. Please add the C++ code snippets to the new files in the Examples folder, as mentioned in the issue #1624: "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.

efratshabtai
efratshabtai requested changes Jun 3, 2024
View reviewed changes
Copy link
Collaborator

@efratshabtai efratshabtai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR, please take a look at my comments and suggestions.

WingCode and others added 3 commits June 8, 2024 00:42
@WingCode @efratshabtai
Apply suggestions from code review
c2068bc 
Fix review comments

Co-authored-by: efratshabtai <efratshabtai@users.noreply.github.com>
@WingCode
Improve docs
0a7096a
@WingCode
Improve docs
b74d669
bettinaheim
bettinaheim reviewed Jun 10, 2024
View reviewed changes
bettinaheim
bettinaheim previously requested changes Jun 10, 2024
View reviewed changes
Copy link
Collaborator

@bettinaheim bettinaheim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comments regarding spelling.

@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 10, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

efratshabtai
efratshabtai previously requested changes Jun 10, 2024
View reviewed changes
Copy link
Collaborator

@efratshabtai efratshabtai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please take a look at my recent comments

@WingCode WingCode requested a review from efratshabtai June 11, 2024 14:19
@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jun 19, 2024
@cuda-quantum-bot
Docs preview for PR #1724.
f12d273
@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jun 19, 2024
@cuda-quantum-bot
Docs preview for PR #1724.
c3389fa
@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 19, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

github-actions bot pushed a commit that referenced this pull request Jun 19, 2024
@cuda-quantum-bot
Docs preview for PR #1724.
1fb3743
@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 20, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@bettinaheim
Copy link
Collaborator

bettinaheim commented Jun 20, 2024 •
edited by github-actions bot
Loading

/ok to test

Command Bot: Processing...

@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jun 20, 2024
@cuda-quantum-bot
Docs preview for PR #1724.
b14c4d5
@bettinaheim bettinaheim merged commit b359c34 into NVIDIA:main Jun 20, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Jun 20, 2024
@bettinaheim bettinaheim changed the title Organize docs Improve structure and clarity of the documentation Jul 29, 2024
@bettinaheim bettinaheim added the documentation Improvements or additions to documentation label Jul 29, 2024
@bettinaheim bettinaheim added this to the release 0.8.0 milestone Jul 29, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@bettinaheim bettinaheim bettinaheim left review comments

@amccaskey amccaskey Awaiting requested review from amccaskey

@bmhowe23 bmhowe23 Awaiting requested review from bmhowe23 bmhowe23 is a code owner

@efratshabtai efratshabtai Awaiting requested review from efratshabtai

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

release 0.8.0

Development

Successfully merging this pull request may close these issues.

Organize Documentation Examples

3 participants

@WingCode @efratshabtai @bettinaheim