Documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 459
- Forks
- 359
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 73
Description
I think we're now at a stage that documentation is needed. While writing instrument drivers I found that digging through the code is becoming too time-intensive. Especially since @alexcjohnson is leaving Copenhagen in a few months and is planning to invite more developers to join the project soon, it is becoming more urgent.
I propose to use Sphinx: http://www.sphinx-doc.org
This is a tool that automatically generates documentation based on reStructuredText and docstrings. This is a convenient way for developers to keep the documentation updated while adding new features.
Additionally, we need flowcharts and other images to clarify how the measurement process is built in relation to data storage and so on.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the project code related to instrument drivers, measurement flow, and data storage, then evaluate the proposed Sphinx and reStructuredText approach. Done means developer documentation exists along with flowcharts or other images explaining the measurement and storage process.
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
- 20/100