Skip to content

📝 Architecture documentation - #795

Merged
lsschmid merged 9 commits into
mainfrom
architecture-documentation
Aug 17, 2026
Merged

📝 Architecture documentation#795
lsschmid merged 9 commits into
mainfrom
architecture-documentation

Conversation

@MaxieHelenBichmann

@MaxieHelenBichmann MaxieHelenBichmann commented Aug 14, 2026

Copy link
Copy Markdown
Collaborator

Description

  • Improve the structure of documentation:
    • separation of modular paper-focused "tools" and more infrastructure-related information "user guide"
    • classifcation of modular tools in categories Synthesis, State Preparation, Decoders, Compilation (potentially better naming/classification possible)
  • Add basic architecture/workflow documentation.
  • Some bug fixes w.r.t. incorrect references to the installation page.

Fixes #784

Assisted-by: Codex for build pipeline summarization, first reviewer

Checklist

  • The pull request only contains commits that are focused and relevant to this change.
  • I have added appropriate tests that cover the new/changed functionality.
  • I have updated the documentation to reflect these changes.
  • The changes follow the project's style guidelines and introduce no new warnings.
  • The changes are fully tested and pass the CI checks.
  • I have reviewed my own code changes.

If PR contains AI-assisted content:

  • Any agent that created, edited, or submitted GitHub content was explicitly authorized for that scope, as required by our AI Usage Guidelines.
  • Every agent-authored or agent-edited public text body begins with the visible disclosure 🤖 *AI text below* 🤖 (titles are exempt).
  • I have disclosed AI assistance in the PR description.
  • I confirm that I have personally reviewed and understood all AI-generated content, and accept full responsibility for it.

@MaxieHelenBichmann MaxieHelenBichmann self-assigned this Aug 14, 2026
@MaxieHelenBichmann MaxieHelenBichmann added the documentation Improvements or additions to documentation label Aug 14, 2026
@MaxieHelenBichmann MaxieHelenBichmann changed the title WIP: 📝 Architecture documentation 📝 Architecture documentation Aug 14, 2026
@MaxieHelenBichmann
MaxieHelenBichmann marked this pull request as ready for review August 14, 2026 12:24
lsschmid and others added 3 commits August 17, 2026 09:03
Set a global `nb_execution_timeout` of 300s. The MyST-NB default of 30s is
too tight for the Monte-Carlo simulations in StatePrep.md, which is what made
the Read the Docs build fail intermittently. Drop the now-redundant per-file
`execution_timeout` overrides in CatStates.md and Encoders.md; ExactSynthesis.md
and cococo.md were at risk on slow builders and are covered now too.

Fold state preparation into the Circuit Synthesis category and rename
Compilation to Logical Compilation. Give each category landing page a grid of
cards instead of a bare toctree, and update the landing page intro to route
readers through the new sections.

Link the abstractions in the architecture page to their API reference entries,
and rename Architecture.md/tools/decoder.md to architecture.md/tools/decoders.md
for consistency with the other pages.

Fix the dangling `installation.md#optional-features` anchor in StatePrep.md;
installation.md is generated from an external template and has no such section,
so the qsample extra is now named inline.

Assisted-by: Claude Opus 5 via Claude Code
@lsschmid

Copy link
Copy Markdown
Collaborator

I renamed and re-ordered the sections a little: state preparation now lives under Circuit Synthesis rather than being its own category, and Compilation is now Logical Compilation.

@lsschmid
lsschmid merged commit bee0b12 into main Aug 17, 2026
10 checks passed
@lsschmid
lsschmid deleted the architecture-documentation branch August 17, 2026 09:00
@github-project-automation github-project-automation Bot moved this from In Progress to Done in MQT Error Correction Aug 17, 2026
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.

📝 Architecture Documentation

2 participants