BradenM / BradenM/micropy-cli

README + Documentation Updates

Open
#395 0 comments 0 reactions 1 assignee Claimed by @BradenM View on GitHub
enhancement
Dominant language
Python
Stars
337
Forks
29
PR merge metrics
No merged PRs in 30d

Description

**Is your feature request related to a problem? Please describe.**

README and documentation are very outdated.

**Describe the solution you'd like**

- [ ] Update to reflect support for micropython-stubber integrated as a stub repository: #304
- [ ] Detail how management of stubs / stub repos is handled.
- [ ] #379
- [ ] Explain upydevice/rshell backends: #294
- [ ] Creating stubs for custom modules (that live on board, not packages/deps related) (pending #394)
- [ ] Updated API reference (via autogendocs w/ mkdocs)
- [ ] Move to mkdocs.
- [ ] #312
- [ ] Add contributor documentation + guidelines.
- [ ] Update package install extras / documentation (especially removal of `create_stubs` extra)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.