Skip to content

Documentation revamp - #601

Draft
matulni wants to merge 1 commit into
TeamGraphix:masterfrom
matulni:docs
Draft

Documentation revamp#601
matulni wants to merge 1 commit into
TeamGraphix:masterfrom
matulni:docs

Conversation

@matulni

@matulni matulni commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

This PR proposes a skeleton for the tutorial section of the documentation.
Feel free to complete the proposed sections or improve the documentation layout by opening PRs on this draft PR.

To render the documentation locally, go to the graphix/graphix/docs directory and run

uv run --extra dev --extra doc make html

TODO list

  • Writing tutorials

    • Tutorials starting page
    • graph_mbqc
    • measurement_calculus
    • transpilation
    • flows
    • pattern_standardization
    • space_minimization
    • pauli_removal
    • pattern_simulation
    • circuit_extraction
    • symbolic
    • type_safety
  • Other sections

    • Installation
    • Getting started
    • Compatiblity
    • Contributing (update existing text)
  • Design

    • Design landing page
    • Choose a more modern theme/colors

For future PRs

  • Graphix plugins
  • Structured API reference
  • Research workflows

Concerning the API, for now we can just add the modules as they appear in the tutorials, even if they are not logically ordered, so that links are clickable.

Useful links

Sphinx documentation
Furo theme documentation

www.writethedocs.org/guide/writing/beginners-guide-to-docs

@codecov

codecov Bot commented Sep 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.29%. Comparing base (00e82f6) to head (085537a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #601   +/-   ##
=======================================
  Coverage   89.29%   89.29%           
=======================================
  Files          49       49           
  Lines        7799     7799           
=======================================
  Hits         6964     6964           
  Misses        835      835           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant