Skip to content

Commit

Permalink
Merge branch 'improvedocs-issue1469' of github.com:shraddha-aangiras/…
Browse files Browse the repository at this point in the history
…qiskit-documentation into improvedocs-issue1469
  • Loading branch information
shraddha-aangiras committed Jun 27, 2024
2 parents c370ad1 + 791d935 commit 91f7945
Show file tree
Hide file tree
Showing 21 changed files with 246 additions and 427 deletions.
70 changes: 0 additions & 70 deletions .github/actions/set-up-ibm-cloud/action.yml

This file was deleted.

91 changes: 0 additions & 91 deletions .github/workflows/deploy-code-engine.yml

This file was deleted.

50 changes: 0 additions & 50 deletions .github/workflows/preview-docs-teardown.yml

This file was deleted.

38 changes: 0 additions & 38 deletions .github/workflows/preview-docs.yml

This file was deleted.

33 changes: 0 additions & 33 deletions .github/workflows/staging.yml

This file was deleted.

40 changes: 0 additions & 40 deletions Dockerfile

This file was deleted.

12 changes: 0 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,6 @@ API docs authors can preview their changes to one of the APIs by using the `-a`
1. Run `npm run gen-api -- -p <pkg-name> -v <version> -a <path/to/docs/_build/html>`.
2. Execute `./start` and open up `http://localhost:3000`, as explained in the prior section.

## Preview the docs in PRs

Contributors with write access to this repository can use live previews of the docs: GitHub will deploy a website using your changes.

To use live previews, push your branch to `upstream` rather than your fork. GitHub will leave a comment with the link to the site. Please prefix your branch name with your initials, e.g. `EA/fix-build-typo`, for good Git hygiene.

## Staging

We also re-deploy the docs every time we merge into `main` at the site https://qiskit-docs-preview-staging.1799mxdls7qz.us-south.codeengine.appdomain.cloud.

This staging environment can be useful to see how the docs are rendering before we push it live to production.

## Execute notebooks

Before submitting a new notebook or code changes to a notebook, you must run
Expand Down
4 changes: 2 additions & 2 deletions docs/run/processor-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Quantum volume: 128

At 127 qubits, the Eagle processor family incorporates more scalable packaging technologies than previous generations. In particular, signals pass through multiple chip layers so as to allow for high-density I/O without sacrificing performance.

See [this blog post](https://research.ibm.com/blog/127-qubit-quantum-processor-eagle) for more about the Eagle processor family.
See [IBM Quantum breaks the 100‑qubit processor barrier](https://www.ibm.com/quantum/blog/127-qubit-quantum-processor-eagle) for more about the Eagle processor family.

* [View available Eagle systems](https://quantum.ibm.com/services/resources?tab=systems&type=Eagle)

Expand Down Expand Up @@ -80,7 +80,7 @@ Egret brings the innovations of tunable couplers onto a 33-qubit platform, resul
* [View available Egret systems](https://quantum.ibm.com/services/resources?tab=systems&type=Egret)

<Admonition type="info" title="Revisions">
`r1` (December 2022) The first realization of the Egret processor has demonstrated the highest Quantum Volume among IBM Quantum&trade; systems and a substantial improvement in two-qubit gate error rates ([https://research.ibm.com/blog/quantum-volume-256](https://research.ibm.com/blog/quantum-volume-256)). This new quantum processor boasts a substantial speedup and fidelity improvement (many gates approaching 99.9%) in two-qubit gates while reducing spectator errors.
`r1` (December 2022) The first realization of the Egret processor has demonstrated the highest Quantum Volume among IBM Quantum&trade; systems and a substantial improvement in two-qubit gate error rates (see [Pushing quantum performance forward with our highest Quantum Volume yet](https://www.ibm.com/quantum/blog/quantum-volume-256)). This new quantum processor boasts a substantial speedup and fidelity improvement (many gates approaching 99.9%) in two-qubit gates while reducing spectator errors.
</Admonition>

## Falcon
Expand Down
4 changes: 4 additions & 0 deletions docs/start/_toc.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@
"title": "Hello world",
"url": "/start/hello-world"
},
{
"title": "Latest updates",
"url": "/start/latest-updates"
},
{
"title": "Advanced setup",
"children": [
Expand Down
Loading

0 comments on commit 91f7945

Please sign in to comment.