# intel/quantum-sdk-docs architecture

> Architecture diagram of the GitHub repository intel/quantum-sdk-docs, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/intel/quantum-sdk-docs
- Repository: https://github.com/intel/quantum-sdk-docs

## Overview

1. This repository is not the Intel Quantum SDK runtime itself; it is the published documentation site for the SDK. The primary “product” here is a static HTML documentation corpus generated from source docs.

2. The top-level architectural boundary is between documentation source/material and generated output. The `docs/` directory contains the rendered site, while `docs/.doctrees/` and `docs/.buildinfo` are Sphinx build artifacts that capture parse state and incremental build metadata.

3. Two documentation systems are involved: Doxygen and Sphinx. README explicitly says the site was generated via both, which implies the repo aggregates API/reference material from code comments and narrative/user guides from Sphinx pages.

4. The site is organized into several major content domains:
   - `docs/api/` for API reference material
   - `docs/dgr/` for the DGR documentation set
   - `docs/fleq/` for the FLEQ documentation set
   - `docs/getting_started/` for onboarding and first-use guidance
   - `docs/tutorial/` for longer walkthroughs and examples

5. Within the DGR section, the pages map to the SDK’s quantum runtime/compiler concepts: circuits, gates, backends, compiler, native/OpenQASM support, full-state simulation, tensor network, MPI, Clifford, QEC, verification, and custom backend/user-pass extension points. This suggests DGR documentation covers a modular backend-and-compilation architecture.

6. Within the FLEQ section, the pages focus on the higher-level language and compilation model: DSL, branching, barriers, coherent transformations, data lists/quantum lists, conversion, higher-order constructs, and debugging. This indicates a separate abstraction layer for expressing quantum programs before lower-level compilation/execution.

7. The documentation structure shows a layered conceptual flow:
   - introductory and getting-started material
   - language/programming model docs
   - compiler and backend docs
   - specialized execution/simulation targets
   - API reference
   - tutorials and examples  
   This mirrors how a user would move from writing programs to understanding compilation and execution targets.

8. `docs/index.html` acts as the site root and navigation hub, with generated navigation/search support in `docs/search.html`, `docs/searchindex.js`, and `docs/genindex.html`. These are standard Sphinx outputs that provide cross-document discovery rather than application logic.

9. Presentation is handled by generated static assets under `docs/_static/` plus the repository’s custom styling in `assets/css/style.scss`. The docs site therefore has a theming layer, but no application server or dynamic frontend backend.

10. The `.doctrees` subtree is an internal Sphinx cache of parsed pages for sections like DGR, FLEQ, getting started, and tutorial. It is important for rebuilds and dependency tracking, but not part of the published content model.

11. From an architecture diagram perspective, the only real “inputs” are the underlying documentation sources and generated API content; the only “outputs” are the static HTML pages and supporting assets. There are no runtime services, databases, or external APIs shown in this repository.

12. In short, the repo is a static documentation distribution with two major content tracks—DGR and FLEQ—plus API reference, onboarding, and tutorials, all assembled through a Sphinx/Doxygen publishing pipeline and served as prebuilt HTML.

Main entry points: [`docs/index.html`](https://github.com/intel/quantum-sdk-docs/blob/main/docs/index.html) (Site root), [`docs/dgr/index.html`](https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/index.html) (DGR docs), [`docs/fleq/index.html`](https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/index.html) (FLEQ docs), [`README.md`](https://github.com/intel/quantum-sdk-docs/blob/main/README.md) (README)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_g_source["Source material"]
  node_n_readme["README<br/>repo overview<br/>[README.md]"]
  node_n_assets_css["Theme CSS<br/>styling<br/>[style.scss]"]
end

subgraph group_g_build["Publishing pipeline"]
  node_n_doxygen["Doxygen<br/>api generator"]
  node_n_sphinx["Sphinx<br/>site generator"]
  node_n_buildinfo["Build cache<br/>sphinx artifact<br/>[.buildinfo]"]
  node_n_doctrees["Doctrees<br/>sphinx cache<br/>[.doctrees]"]
end

subgraph group_g_site["Published site"]
  node_n_docs_root["Site root<br/>html hub<br/>[index.html]"]
  node_n_search["Search index<br/>discovery<br/>[search.html]"]
  node_n_api["API docs<br/>reference set<br/>[index.html]"]
  node_n_getting_started["Getting started<br/>onboarding<br/>[index.html]"]
  node_n_tutorial["Tutorials<br/>walkthroughs<br/>[index.html]"]
  node_n_dgr["DGR docs<br/>runtime/compiler docs<br/>[index.html]"]
  node_n_dgr_compile["Compile path<br/>compiler flow<br/>[compiler.html]"]
  node_n_dgr_backends["Backends<br/>[backends.html]"]
  node_n_dgr_ext["Extensions<br/>integration points"]
  node_n_fleq["FLEQ docs<br/>language docs<br/>[index.html]"]
  node_n_fleq_lang["DSL model<br/>program model<br/>[dsl.html]"]
  node_n_fleq_data["Data model<br/>quantum/classical data<br/>[datalist.html]"]
  node_n_static["Static assets<br/>site assets"]
  node_n_html_sections["HTML sections<br/>published content"]
end

node_n_readme -->|"describes"| node_n_doxygen
node_n_readme -->|"describes"| node_n_sphinx
node_n_assets_css -->|"themes"| node_n_static
node_n_doxygen -->|"builds"| node_n_api
node_n_sphinx -->|"renders"| node_n_html_sections
node_n_sphinx -->|"tracks"| node_n_buildinfo
node_n_sphinx -->|"caches"| node_n_doctrees
node_n_doctrees -->|"supports"| node_n_html_sections
node_n_buildinfo -->|"supports"| node_n_html_sections
node_n_api -->|"navigates"| node_n_docs_root
node_n_getting_started -->|"navigates"| node_n_docs_root
node_n_tutorial -->|"navigates"| node_n_docs_root
node_n_dgr -->|"navigates"| node_n_docs_root
node_n_fleq -->|"navigates"| node_n_docs_root
node_n_dgr -->|"organizes"| node_n_dgr_compile
node_n_dgr -->|"organizes"| node_n_dgr_backends
node_n_dgr -->|"organizes"| node_n_dgr_ext
node_n_fleq -->|"organizes"| node_n_fleq_lang
node_n_fleq -->|"organizes"| node_n_fleq_data
node_n_static -->|"serves"| node_n_docs_root
node_n_search -->|"indexes"| node_n_docs_root

click node_n_readme "https://github.com/intel/quantum-sdk-docs/blob/main/README.md"
click node_n_assets_css "https://github.com/intel/quantum-sdk-docs/blob/main/assets/css/style.scss"
click node_n_docs_root "https://github.com/intel/quantum-sdk-docs/blob/main/docs/index.html"
click node_n_search "https://github.com/intel/quantum-sdk-docs/blob/main/docs/search.html"
click node_n_api "https://github.com/intel/quantum-sdk-docs/blob/main/docs/api/index.html"
click node_n_getting_started "https://github.com/intel/quantum-sdk-docs/blob/main/docs/getting_started/index.html"
click node_n_tutorial "https://github.com/intel/quantum-sdk-docs/blob/main/docs/tutorial/index.html"
click node_n_dgr "https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/index.html"
click node_n_dgr_compile "https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/compiler.html"
click node_n_dgr_backends "https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/backends.html"
click node_n_dgr_ext "https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/custom_backend.html"
click node_n_fleq "https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/index.html"
click node_n_fleq_lang "https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/dsl.html"
click node_n_fleq_data "https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/datalist.html"
click node_n_buildinfo "https://github.com/intel/quantum-sdk-docs/blob/main/docs/.buildinfo"
click node_n_doctrees "https://github.com/intel/quantum-sdk-docs/blob/main/docs/.doctrees"
click node_n_static "https://github.com/intel/quantum-sdk-docs/tree/main/docs/_static"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_n_readme,node_n_assets_css toneBlue
class node_n_doxygen,node_n_sphinx,node_n_buildinfo,node_n_doctrees toneAmber
class node_n_docs_root,node_n_search,node_n_api,node_n_getting_started,node_n_tutorial,node_n_dgr,node_n_dgr_compile,node_n_dgr_backends,node_n_dgr_ext,node_n_fleq,node_n_fleq_lang,node_n_fleq_data,node_n_static,node_n_html_sections toneMint
```

## Components

### Source material

Repository inputs and authored documentation content

- [README](https://github.com/intel/quantum-sdk-docs/blob/main/README.md): repo overview · Project description and documentation publishing notes · `README.md`
- [Theme CSS](https://github.com/intel/quantum-sdk-docs/blob/main/assets/css/style.scss): styling · Custom site styling for the published documentation · `assets/css/style.scss`

### Publishing pipeline

Doc generation and assembly steps

- **Doxygen**: api generator · Reference documentation source for code comments and API pages
- **Sphinx**: site generator · Narrative documentation builder and HTML publisher
- [Build cache](https://github.com/intel/quantum-sdk-docs/blob/main/docs/.buildinfo): sphinx artifact · Incremental build metadata and parsed document cache · `docs/.buildinfo`
- [Doctrees](https://github.com/intel/quantum-sdk-docs/blob/main/docs/.doctrees): sphinx cache · Parsed page cache for section rebuilds and dependency tracking · `docs/.doctrees`

### Published site

Prebuilt static HTML documentation and supporting assets

- [Site root](https://github.com/intel/quantum-sdk-docs/blob/main/docs/index.html): html hub · Top-level landing page and navigation entry point · `docs/index.html`
- [Search index](https://github.com/intel/quantum-sdk-docs/blob/main/docs/search.html): discovery · Generated search and index support for navigation · `docs/search.html`
- [API docs](https://github.com/intel/quantum-sdk-docs/blob/main/docs/api/index.html): reference set · API reference section generated into the published site · `docs/api/index.html`
- [Getting started](https://github.com/intel/quantum-sdk-docs/blob/main/docs/getting_started/index.html): onboarding · Introductory guidance for first use and next steps · `docs/getting_started/index.html`
- [Tutorials](https://github.com/intel/quantum-sdk-docs/blob/main/docs/tutorial/index.html): walkthroughs · Long-form examples and guided exercises · `docs/tutorial/index.html`
- [DGR docs](https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/index.html): runtime/compiler docs · Documentation for circuits, compiler, backends, and execution targets · `docs/dgr/index.html`
- [Compile path](https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/compiler.html): compiler flow · Circuit, gates, compiler, native/OpenQASM, and output concepts · `docs/dgr/compiler.html`
- [Backends](https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/backends.html): execution backends · Full-state, tensor network, MPI, Clifford, QEC, and verification targets · `docs/dgr/backends.html`
- [Extensions](https://github.com/intel/quantum-sdk-docs/blob/main/docs/dgr/custom_backend.html): integration points · Custom backend and user-pass extension mechanisms · `docs/dgr/custom_backend.html`
- [FLEQ docs](https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/index.html): language docs · Documentation for the higher-level DSL and compilation model · `docs/fleq/index.html`
- [DSL model](https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/dsl.html): program model · DSL, branching, barriers, higher-order constructs, and debugging · `docs/fleq/dsl.html`
- [Data model](https://github.com/intel/quantum-sdk-docs/blob/main/docs/fleq/datalist.html): quantum/classical data · Data lists, quantum lists, conversion, and ordering rules · `docs/fleq/datalist.html`
- [Static assets](https://github.com/intel/quantum-sdk-docs/tree/main/docs/_static): site assets · Generated CSS, JS, search tools, and theme resources · `docs/_static`
- **HTML sections**: published content · Rendered documentation pages across API, DGR, FLEQ, getting started, and tutorials

## Connections

- README → Doxygen: describes · README states the site was generated with Doxygen
- README → Sphinx: describes · README states the site was generated with Sphinx
- Theme CSS → Static assets: themes · Custom styling is packaged into the published static assets
- Doxygen → API docs: builds · Doxygen feeds the API reference section
- Sphinx → HTML sections: renders · Sphinx produces the narrative documentation pages
- Sphinx → Build cache: tracks · Sphinx incremental build metadata is stored for rebuilds
- Sphinx → Doctrees: caches · Parsed document trees are cached for each documentation set
- Doctrees → HTML sections: supports · Doctrees support regeneration of the rendered site
- Build cache → HTML sections: supports · Build info supports incremental publishing
- API docs → Site root: navigates · API docs are part of the main site navigation
- Getting started → Site root: navigates · Getting started is a top-level section from the site root
- Tutorials → Site root: navigates · Tutorials are a top-level section from the site root
- DGR docs → Site root: navigates · DGR is a major documentation domain in the site hierarchy
- FLEQ docs → Site root: navigates · FLEQ is a major documentation domain in the site hierarchy
- DGR docs → Compile path: organizes · DGR content centers on circuit and compiler flow
- DGR docs → Backends: organizes · DGR content covers execution and simulation backends
- DGR docs → Extensions: organizes · DGR content includes extension and customization points
- FLEQ docs → DSL model: organizes · FLEQ content focuses on the language and control-flow model
- FLEQ docs → Data model: organizes · FLEQ content explains program data structures and conversion
- Static assets → Site root: serves · Static theme assets support the rendered site pages
- Search index → Site root: indexes · Search and genindex provide cross-document discovery from the site root
