Skip to content

Fix several broken links in Markdown files #8311

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

Open
mhucka wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix several broken links in Markdown files #8311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31abea9
Fix several broken links in Markdown files
mhucka Sep 8, 2026
2864e08
Replace bit.do links with goo.gle links
mhucka Sep 8, 2026
c204d24
Fix some broken link fragments
mhucka Sep 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cirq-core/cirq/protocols/json_test_data/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

This folder contains test data for Cirq's JSON serialization functionality. For
more information, please see
[`docs/dev/serialization.md`](/docs/dev/serialization.md).
[`docs/dev/serialization.md`](../../../../docs/dev/serialization.md).
2 changes: 1 addition & 1 deletion cirq-ionq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img width="190px" alt="Cirq logo"
src="https://raw.githubusercontent.com/quantumlib/Cirq/refs/heads/main/docs/images/Cirq_logo_color.svg"
><img width="50px" height="0" alt=""><img width="200px" alt="IonQ logo"
src="https://ionq.com/images/ionq-logo-dark.svg">
src="https://upload.wikimedia.org/wikipedia/commons/d/d4/IonQ_corp_logo.svg">
</div>

# cirq-ionq
Expand Down
2 changes: 1 addition & 1 deletion dev_tools/triage-party/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Kubernetes.
Please refer to the official [Triage Party documentation] for details on the available configuration
options.

[Triage Party documentation]: https://github.com/google/triage-party/blob/main/docs/config.md
[Triage Party documentation]: https://github.com/google/triage-party/blob/master/docs/config.md

### 2. Static Resources & Theming (CSS & Favicon)

Expand Down
4 changes: 2 additions & 2 deletions docs/build/ecosystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ The following document provides an ecosystem overview of various open-source too
|--- |--- |
|[Alpine Quantum Technologies](https://quantumai.google/cirq/hardware/aqt/getting_started)|Trapped ions|
|[IonQ](https://quantumai.google/cirq/hardware/ionq/getting_started)|Trapped ions|
|[IQM](https://iqm-finland.github.io/cirq-on-iqm/)|Superconducting qubits|
|[IQM](https://docs.iqm.tech/iqm-client/user_guide_cirq.html)|Superconducting qubits|
|[Microsoft Azure Quantum](https://quantumai.google/cirq/hardware/azure-quantum/getting_started_ionq)|Trapped ions (Honeywell and IonQ)|
|[Pasqal](https://quantumai.google/cirq/hardware/pasqal/getting_started)|Neutral atoms|

For more information for vendors about integrating with Cirq,
see our [RFC page](../dev/rfc_process.md#new_hardware_integrations).
see our [RFC page](../dev/rfc_process.md#new-hardware-integrations).

## High performance quantum circuit simulators

Expand Down
4 changes: 2 additions & 2 deletions docs/citation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ When using our projects, please cite them according to the following guide:
| Qualtran | https://github.com/quantumlib/qualtran#how-to-cite-qualtran |
| ReCirq | https://github.com/quantumlib/ReCirq#how-to-cite-recirq |
| Stim | https://github.com/quantumlib/stim#how-cite-stim |
| TensorFlow Quantum | https://github.com/tensorflow/quantum#references|
| Tesseract Decoder | https://github.com/quantumlib/tesseract-decoder#citation|
| TensorFlow Quantum | https://github.com/tensorflow/quantum#references |
| Tesseract Decoder | https://github.com/quantumlib/tesseract-decoder#citation |
2 changes: 1 addition & 1 deletion docs/dev/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Note that if you are using PyCharm, you might have to use the command Restart &
1. Fork the Cirq repo (Fork button in upper right corner of
[repo page](https://github.com/quantumlib/Cirq)).
Forking creates a new GitHub repo at the location
https://github.com/USERNAME/cirq where `USERNAME` is
`https://github.com/USERNAME/cirq` where `USERNAME` is
your GitHub id.
1. Clone the fork you created to your local machine at the directory
where you would like to store your local copy of the code, and `cd` into the newly created directory.
Expand Down
4 changes: 2 additions & 2 deletions docs/dev/triage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Cirq Triage

Original RFC: [bit.do/cirq-triage](https://bit.do/cirq-triage)
Original RFC: [goo.gle/cirq-rfc-triage](https://goo.gle/cirq-rfc-triage)

## **Objective**

Expand All @@ -14,7 +14,7 @@ The goals for this document are as follows:

[Triage Party](https://github.com/google/triage-party) is a stateless web app to optimize issue and PR triage for large open-source projects using the GitHub API.

Our deployed version is here (a static IP, domain request is in progress): [http://bit.do/cirq-triage-party](http://bit.do/cirq-triage-party)
Our deployed version is here (a static IP, domain request is in progress): [goo.gle/cirq-triage-party](http://goo.gle/cirq-triage-party)

[GitHub Actions](https://github.com/features/actions) is GitHub's workflow automation platform. We use it for continuous integration testing as well as for stale issue handling later described here.

Expand Down
1 change: 1 addition & 0 deletions docs/dev/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ the following:
* Similarly, symbols in vendor packages, like [cirq-google](https://quantumai.google/reference/python/cirq_google/all_symbols), [cirq-aqt](https://quantumai.google/reference/python/cirq_aqt/all_symbols) are also not covered by the compatibility guarantee.
* If a symbol is available through the `cirq` Python module or its submodules, but is not documented, then it is **not** considered part of the public API.

<a name="what-is-not-covered"></a>

@pavoljuhas pavoljuhas Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The auto-generated anchor seems to be the same. Please remove.

@mhucka mhucka Sep 8, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The auto-generated anchor seems to be the same. Please remove.

Actually, it was hand-generated. I added after finding that markdown link checkers flagged the earlier reference in the file (#what-is-not-covered) as not found. I think it's because the emphasis text in the header (_not_) causes Markdown processors to create a different link than #what-is-not-covered.

Alternatively, I could change the _not_ to plain not and avoid the problem.

@pavoljuhas pavoljuhas Sep 8, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

By auto-generated I meant that if I visit https://github.com/quantumlib/Cirq/blob/main/docs/dev/versions.md and hover the mouse over that section heading, the browser shows the same anchor. In other words, GitHub already interprets that heading as having the #what-is-not-covered anchor.

Sure, changing to plain "not" will probably appease the checkers.

## What is _not_ covered
* **Experimental APIs**: To facilitate development, we exempt some API symbols clearly marked as experimental from the compatibility guarantees. In particular, the following are not covered by any compatibility guarantees:
* any symbol in the `cirq.contrib` module or its submodules.
Expand Down
2 changes: 1 addition & 1 deletion docs/hardware/pasqal/access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Access and Authentication

Pasqal's API is not yet open for public access. In case you're interested, contact
us through our [website](https://pasqal.io/contact/) to request access.
us through our [website](https://www.pasqal.com/contact-us/) to request access.

## API Access

Expand Down
Loading