microsoft / microsoft/Qcodes

Retire the Loop in the documentation

Open
#1,048 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
459
Forks
359
Avg merge
3d 6h
Merged PRs (30d)
73

Description

The first thing that a new user sees when stumbling across the QCoDeS documentation is how to set up a measurement with the old, hopefully soon-to-be-retired Loop. That should not be so. I propose that we shuffle around the documentation a bit and in particular make the `Tutorial.ipynb` and the `docs/index.rst` use the new dataset and context manager.

Contributor guide

Open the contributing guide

Research direction

Read docs/index.rst and Tutorial.ipynb to understand how the documentation currently introduces measurements and the old Loop. Update both entry points to use the new dataset and context manager, then verify that a new user no longer encounters the old Loop as the initial setup path.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.