adafruit / adafruit/Adafruit_CircuitPython_Bundle

"Drivers" vs "Helpers" is not so helpful as a top-level distinction

Open
#419 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Shell
Stars
1k
Forks
205
Avg merge
5h 34m
Merged PRs (30d)
4

Description

I find that dividing libraries between device "drivers" and "helpers" is not so helpful. I often have to think about which top-level category to look in. I would rather just get rid of this distinction. For example, "Board-specific Helpers" could just be "Board Libraries".

Even the filename `drivers.rst` could be changed to `libraries.rst`.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with drivers.rst and inspect its top-level headings and any references to the filename. Search the repository for the Drivers and Helpers labels and drivers.rst; the work is done when the documentation uses the unified library naming consistently and links still resolve.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.