OpenStickCommunity / OpenStickCommunity/GP2040-CE
Add docs on creating configuration pages for add-ons
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 2.5k
- Forks
- 666
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 7
Description
Problem
Right now I am developing an add-on for taiko drum controls for a DIY taiko drum (basically just presses certain buttons on reaching certain thresholds on certain ADC pins) and there are no docs on creating a config page for a plugin. This makes it difficult for developers to create add-ons for contributing or for their own purposes.
Solution
Just write docs for creating config pages for addons. That will make the lives of everyone working on GP-2040 a little easier.
Do you plan to work on this feature yourself?
I honestly have no idea how all of this works, I was barely even able to write an addon by myself. So sorry, but I can't help with this one :(
Contributor guide
No contributing guide indexed for this repository
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
Start by locating the existing add-on implementation and any current configuration-page examples in the repository. Document the steps and conventions needed to create an add-on configuration page, then verify the instructions against a representative add-on.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100