Skip to content

docs: overhaul plugin development documentation#17

Open
ImDevinC wants to merge 1 commit intoStreamController:mainfrom
ImDevinC:docs/plugin-dev-overhaul
Open

docs: overhaul plugin development documentation#17
ImDevinC wants to merge 1 commit intoStreamController:mainfrom
ImDevinC:docs/plugin-dev-overhaul

Conversation

@ImDevinC
Copy link
Copy Markdown

Summary

  • Replace ActionBase with ActionCore documentation reflecting the new base class
  • Add comprehensive EventSystem docs for hardware input handling and event routing
  • Add GenerativeUI docs explaining automatic config widget state management
  • Significantly expand and improve existing tutorials and guides

Changes

New Documentation

  • ActionCore_py.md - New base class for actions (replaces ActionBase)
  • EventSystem.md - Hardware input events and EventAssigner usage
  • GenerativeUI.md - Config widget automation system

Updated Guides

  • PluginBase_py.md - Expanded with new patterns
  • SimpleAction_py.md - Updated for ActionCore
  • main_py.md - Improved plugin entry point docs
  • AddCounter.md - More thorough counter tutorial
  • add_a_backend_action.md - Backend action improvements
  • add_a_plugin_backend.md - Plugin backend docs
  • localization.md - Expanded i18n coverage
  • add_config_rows.md - Config row tutorial updates
  • gtk_intro.md - GTK introduction tweaks

Advanced Concepts

  • DeckController.md, PageCaching.md, Signals.md - Minor updates

Removed

  • ActionBase_py.md - Replaced by ActionCore

Disclosure
This change was developed with the assistance of AI, but was reviewed and tested by a human.

- Replace ActionBase with ActionCore documentation
- Add EventSystem docs for hardware input handling
- Add GenerativeUI docs for config widget automation
- Update PluginBase, SimpleAction, and main.py guides
- Expand tutorials: AddCounter, backend actions, localization
- Improve config/add_config_rows and gtk_intro sections
- Update advanced concepts: DeckController, PageCaching, Signals
- Update mkdocs.yml navigation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant