Skip to content

Documentation: Add more links for built in modules #6326

Open
@jepler

Description

@jepler

The CircuitPython core documentation is a terse reference, not a tutorial. In many cases, we have some other sources of documentation that we hope users will find useful. Let's link to them! I think most modules fall into one or more of these categories:

  • There's a tutorial guide for it. Link to the tutorial.
  • It's intended to be used by a wrapper library (for example, neopixel_write). Link to the wrapper library and to its learn guide
  • It's a subset of a standard Python module. Link to the Python docs with a standard disclaimer that the version for CircuitPython is intended to be a compatible subset except as noted.
    Sometimes, this might mean adding multiple links (displayio, for example). In some cases, of course, none of these options may make sense. This could be because the library is suitably obscure (e.g., _eve) or for some other reason.

This will probably take some time to implement, so while the following checklist may be handy, it'd be good to double-check all modules before ultimately closing this issue.

Checklist moved to comment below.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions