Skip to content

Adds a short tProc v2 migration guide under the docs topics section. - #412

Merged
meeg merged 6 commits into
openquantumhardware:docs-migration-tprocv2from
JayChien04717:Jay417
Sep 12, 2026
Merged

meeg merged 6 commits into
openquantumhardware:docs-migration-tprocv2from
JayChien04717:Jay417

Conversation

@JayChien04717

Copy link
Copy Markdown

Adds a short tProc v2 migration guide under the docs topics section.

The guide covers:

hardware sweeping changes from tProc v1 to v2
timing terminology updates
pulse playback changes
natural units used by the tProc v2 API

@JayChien04717 JayChien04717 changed the title Jay417 modify index May 28, 2026
@mmdiego mmdiego changed the title modify index Adds a short tProc v2 migration guide under the docs topics section. Jun 1, 2026
@mmdiego mmdiego added the documentation Improvements or additions to documentation label Jun 1, 2026
@mmdiego mmdiego added this to the Next Release milestone Jun 1, 2026
lharnaldi added a commit that referenced this pull request Sep 5, 2026
Content originally proposed in PR #412 by Jay Chien against the old
docs/*.rst tree (now superseded by docs/source/, so that PR no longer
applies cleanly). Ports it into the current docs/source/topics/ tree,
crediting the original author, and verifies every API name used
(add_loop, QickSweep1D, get_pulse_param, get_time_param, delay/
delay_auto/wait_auto, AveragerProgramV2.acquire) against qick.asm_v2
and qick.qick_asm. Also fixes the example-code page's Markdown-style
headings/links, which were invalid in an .rst file.

Verified with a full local sphinx-build: same pre-existing 26-warning
baseline, no new warnings from either page.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@lharnaldi

Copy link
Copy Markdown
Contributor

Thanks for this, @JayChien04717 — the migration guide and example-code list are both genuinely useful additions and were missing from our docs.

We recently restructured the docs tree from a flat docs/*.rst layout to docs/source/ (as part of a broader tProc v2 documentation pass, see #430), which is why this PR no longer applies cleanly against main. Rather than ask you to rebase across that restructuring, I've ported your content into the new tree with credit in #430:

  • docs/source/topics/tprocv2_migration.rst (your migration guide)
  • docs/source/topics/example_code.rst (your example-code list, with the Markdown-style headings/links fixed to valid RST)

Both are wired into docs/source/topics/index.rst and verified against the current API. Closing this one in favor of that — thanks again for the contribution!

@lharnaldi lharnaldi closed this Sep 5, 2026
lharnaldi added a commit that referenced this pull request Sep 5, 2026
Content originally proposed in PR #412 by Jay Chien against the old
docs/*.rst tree (now superseded by docs/source/, so that PR no longer
applies cleanly). Ports it into the current docs/source/topics/ tree,
crediting the original author, and verifies every API name used
(add_loop, QickSweep1D, get_pulse_param, get_time_param, delay/
delay_auto/wait_auto, AveragerProgramV2.acquire) against qick.asm_v2
and qick.qick_asm. Also fixes the example-code page's Markdown-style
headings/links, which were invalid in an .rst file.

Verified with a full local sphinx-build: same pre-existing 26-warning
baseline, no new warnings from either page.
@meeg meeg reopened this Sep 12, 2026
@meeg
meeg changed the base branch from main to docs-migration-tprocv2 September 12, 2026 01:03
@meeg
meeg merged commit e64d9d1 into openquantumhardware:docs-migration-tprocv2 Sep 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants