microsoft / microsoft/Qcodes

How to write api docs (contributing) is outdated

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

Description

This reflects how we used to document not how we currently do it https://qcodes.github.io/Qcodes//community/contributing.html#documenting-qcodes

It should be updated

Contributor guide

Open the contributing guide

Research direction

Start with the linked contributing.html#documenting-qcodes section and compare its instructions with the current API documentation process. Update the section so it describes the current workflow rather than the former one. Done means the contributing guidance accurately reflects how QCoDeS is currently documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.