Skip to content

docs(plugins): document Runner components and APIs - #130

Open
RockChinQ wants to merge 5 commits into
mainfrom
docs/4.11-event-processor
Open

docs(plugins): document Runner components and APIs#130
RockChinQ wants to merge 5 commits into
mainfrom
docs/4.11-event-processor

Conversation

@RockChinQ

@RockChinQ RockChinQ commented Sep 9, 2026

Copy link
Copy Markdown
Member

Documents unified Runner plugin development in Chinese, English, and Japanese. The guide covers both Runner usages: implementing Agent execution and handling declared platform events for plugin processors. It includes component manifests, all 17 supported platform events, streaming replies, debugging, and processor binding.

Reorganizes the plugin API reference around each component's context, then documents platform APIs and LangBot APIs separately. It also adds validation scripts that execute the tutorial examples across all three translations and verify that their Python and YAML stay aligned.

Validation:

  • Runner tutorial verification: 10 cases passed with the matching SDK.
  • npm test: 36 Node tests and 14 Python tests passed.
  • npm run typecheck passed.
  • npm run build passed, including all 30 static-output checks.
  • Local browser preview checked; the example plugin was exercised through the Host/runtime and a localhost OneBot peer. Third-party platform delivery was not covered by these local checks.

@RockChinQ RockChinQ changed the title docs(plugins): add EventProcessor component tutorial docs(plugins): document Runner components and APIs Sep 10, 2026
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