wagtail/wagtail-ai

Revise documentation

Opened this issue · 2 comments

nimasmi commented

Wagtail AI

Some thoughts on the current documentation. Since I started drafting this, @tomusher merged @tm-kn's wagtail/wagtail-vector-index#15 on wagtail-vector-index, and his own #42. This might be a bit out of date, so I've dumped my notes here for discussion.

  • The documentation (in docs/) is a lot more about wagtail-ai the AI tool, than the two example plugins it provides now.
  • Question: What is the aim of the package? The plugins, and being a tool for site implementers to add ready-made AI integrations, or the plugin system, and being a tool for site implementers to write custom AI integrations? It could do with some clearer messaging.
  • There is no hosted documentation. wagtail-ai.readthedocs.io/latest
  • There are no links between files in the docs folder.
  • The example video is with an older Wagtail/Draftail combo, where the edit interface is permanently shown. Wagtail 5.2.2 doesn't have these buttons normally. We could do with an updated video, or instructions how to use with the hidden toolbar.
  • The echo backend is not documented. For a moment at first I thought it was an Amazon Echo backend.