Adjust docs for Getting started guide #3307
Merged
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
- Minor issues found through walk-through - Google colabs are meant to be downloaded, so image links need to be absolute - Rearrange text so that project creation/selection happens before trying to enable the API - Add link to reservation colab on getting started guide.
balopat
reviewed
Sep 10, 2020
docs/tutorials/google/colab.ipynb
Outdated
| @@ -35,7 +35,7 @@ | |||
| "You can retrieve ipython notebooks in the cirq repository by\n", | |||
| "going to the [doc directory](https://github.com/quantumlib/Cirq/tree/master/docs). For instance, this colab template can be found [here](https://github.com/quantumlib/Cirq/blob/master/docs/tutorials/google/colab.ipynb). Select the file that you would like to download and then click the \"Raw\" button in the upper right part of the window:\n", | |||
| "\n", | |||
| "\n", | |||
| "\n", | |||
There was a problem hiding this comment.
Why are we referring to the RTD URL when this will end up on our devsite?
Are you running this locally? Or in Colab? Where does the relative image not work?
if we absolutely need absolute links (pun intended) we could link to the raw image on github on master (a particular commit would be better) - but referring to the Readthedocs URL is definitely odd.
There was a problem hiding this comment.
The relative links won't work if you download the colab and then run it through colab, which you may want to do for the getting started guide and the colab template. I changed it to github absolute URLs.
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.
so image links need to be absolute
happens before trying to enable the API