docs: Write bigger picture
Open
docs
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
We definitely need to fill in the doc in the guide before adding features or things.
The reason for p1 is that it can be hard to figure out by using qcodes, what things do and why they are here or implement a certain way.
See f.ex #223.
Contributor guide
Research direction
Start by reviewing the guide and the related issue #223 to identify the missing bigger-picture context. Done means the guide explains what the Qcodes components do, why they exist, and why they are implemented in their current way before further features are added.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100