Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

Published 20 hours ago • verified publisher icon LAION-AI

Cleanup plugins documentation

Open olliestanley opened this issue 2 years ago • 4 comments

  • Move most content of inference/worker/PLUGINS.md to docs/.
  • Move technical content to inference/worker/README.md.
  • Cleanup plugins docs and add more explanation on using them in the web UI.

olliestanley avatar May 08 '23 11:05 olliestanley

@olliestanley i would like to get involved in this incredible project. Can I take this as my first issue?

y3sar avatar May 08 '23 14:05 y3sar

@olliestanley i would like to get involved in this incredible project. Can I take this as my first issue?

Sure. You may need to spend some time to understand how the plugins work in the UI to write good documentation for it, but feel free to ask here if you have any questions

olliestanley avatar May 08 '23 14:05 olliestanley

@olliestanley ok ill keep you updated

y3sar avatar May 08 '23 15:05 y3sar

@olliestanley Hi, I'm a bit confused about where I should put the contents of Plugins.md in docs/. Should it be under guides/developers?. And I have used plugins in the Web-UI I'm currently writing a doc for how to use it in the UI. Thanks in advance

y3sar avatar May 09 '23 13:05 y3sar

adding some maybe related links in here: https://github.com/someone13574/oasst-plugin-template

andrewm4894 avatar May 31 '23 17:05 andrewm4894

p.s. im going to try start with this more narrow task to just create a tutorial or sorts on how to use it https://github.com/LAION-AI/Open-Assistant/issues/3271

andrewm4894 avatar May 31 '23 17:05 andrewm4894

Made initial minimal PR here

https://github.com/LAION-AI/Open-Assistant/pull/3272

andrewm4894 avatar May 31 '23 22:05 andrewm4894