stream icon indicating copy to clipboard operation
stream copied to clipboard

Make custom connector documentation more beginner-friendly

Open sirjonathan opened this issue 9 years ago • 1 comments

https://github.com/xwp/stream/wiki/Creating-a-Custom-Connector

Offer more complete start-to-finish guidance. A few specific suggestions:

  • give them a complete plugin file that they can edit and drop in place (i.e. include plugin headings).
  • explain, outside of code documentation, how triggering Stream works (i.e. the callback to the action)
  • Offer some actual examples along with the foo / bar (i.e. wanting to trigger Stream when some action happens in a custom plugin)

sirjonathan avatar Feb 14 '16 18:02 sirjonathan

@kasparsd I feel this could better be served by an example plugin repo or template repo for creating connectors. Thoughts?

kopepasah avatar Jul 07 '20 16:07 kopepasah