Update and make minor additions to docs/ #7175
Open
+161
−159
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
With the deprecation of the cirq-rigetti module in Cirq 1.5, having sections about it in the documentation seems like it would be confusion to readers.
It seems like the Docker container may not be used solely for the Rigetti module, so I left the other text about Docker and only removed the statement involving Rigetti.
This entire section still needs a good re-think and more revisions. For now, I just removed mention of the labels that have been changed.
It's true that the section on what's covered mentioned that vendor modules are not, but it seemed strange that it was not mentioned in the section that is specifically about what's no covered.
Mostly fix capitalization and occasional missing hyphens.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7175 +/- ##
=======================================
Coverage 98.13% 98.13%
=======================================
Files 1095 1095
Lines 95649 95649
=======================================
Hits 93867 93867
Misses 1782 1782 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Putting the bullet item about hardware modules seems higher in the list seems like it's better, so that the flow of concepts goes somewhare more general to somewhat more specific.
Changes: * There were 3 H1 headings, and at the same time, the first heading did not match what is in the TOC. I changed this to have one H1 heading that matches the TOC text, made the remaining headings H2, and added a lead-in paragaraph * Rewrote the section about using the issue tracker in attempt to be more specific and clear. * Added a section about using the Q.C. Stack Exchange. * Added a section about using email to contact us.
A trivial change to match the way other headings were written.
Removed more no-longer-existing issue labels, and rewrote section on stale issue/PR heading to be more succinct.
Capitalization and placement of colon characters.
mhucka
requested review from
mrwojtek,
vtomole,
a team,
HGSilveri,
dabacon,
wcourtney and
verult
as code owners
It has no Cirq interface, and it's a bit too early stage still.
mhucka
changed the title
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.
Changes:
Removed mention of Rigetti from indexes and other places, but left docs/hardware/rigetti. The intention is to stop advertising it because it's being deprecated, but leave the docs so that people who still use it can find some documentation.
Added a statement at the top of all the files in docs/hardware/rigetti stating it's deprecated in this release.
In the versioning process document, clarified the backwards compatibility policy w.r.t. hardware vendor interface modules.
Added mention of new Tesseract Decoder project in a couple of relevant places.
Made updates to the triage process document.
Made updates to the tool ecosystem page.
Made updates to the support page with more info.
Fixed tiny typos, capitalization inconsistencies, missing hyphens, tiny formatting niggles like putting a few more things in
code face.