Issue 217 | Docs: getting started 3 level tutorials #222
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
psschwei
reviewed
Mar 21, 2023
README.md
Outdated
| <details> | ||
| <summary>1. Hello World quickstart</summary> | ||
|
|
||
| 1 - Create program file `hello_qiskit.py` |
There was a problem hiding this comment.
Would it be worth it to have a samples/ directory with these code snippets in it? so folks don't have to c&p...
There was a problem hiding this comment.
getting started is now referring to docker compose jupyter instance which has everything needed (all files and examples)
README.md
Outdated
| 2 - Run program file | ||
| ```python | ||
| from quantum_serverless import QuantumServerless, Program | ||
| serverless = QuantumServerless(...) # serverless setup is provided by your admin or use docker compose (refer to all-in-one quickstart) |
There was a problem hiding this comment.
the all-in-one is step 2, so I'd add the docker-compose setup before this (so that users don't have to stop and go back to setup their environment)
There was a problem hiding this comment.
I simplified it to bare minimum. Jen will conduct user research to figure out what is the best way to describe getting started.
jenglick
approved these changes
Mar 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Docs: getting started 3 level tutorials
Details and comments
Closes #217