hardbyte / hardbyte/python-can

Documentation Guides

Open
#1,035 0 comments 0 reactions 0 assignees View on GitHub
docs enhancement
Dominant language
Python
Stars
1.6k
Forks
697
PR merge metrics
No merged PRs in 30d

Description

python-can could really do with a few [documentation guides](https://docs-guide.readthedocs.io/en/latest/doctypes/) to compliment the example code and reference docs.

> Guides are meat of documentation and they should:
> - be comprehensive,
> - show vast majority of possible options (but should not show all possible options -- that is the task for reference),
> - show how all concepts fit together,
> - answer the question "why?".

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.