Skip to content

Commit

Permalink
Merge pull request #59 from kbayliss/main
Browse files Browse the repository at this point in the history
Update docs to include adding 'ai' to RichText features
  • Loading branch information
tomusher authored Feb 16, 2024
2 parents c8539f7 + 8c9ea00 commit a14a677
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
2. Add `wagtail_ai` to your `INSTALLED_APPS`
```
INSTALLED_APPS = [
"wagtail_ai",
# ...
"wagtail_ai",
]
```
3. Add an AI chat model and backend configuration (by default, `MODEL_ID` can be any model supported by [the "LLM" library](https://llm.datasette.io/en/stable/)).
Expand All @@ -26,3 +26,6 @@
}
```
4. If you're using an OpenAI model, specify an API key using the `OPENAI_API_KEY` environment variable, or by setting it as a key in [`INIT_KWARGS`](ai-backends.md#init-kwargs).
5. If you've restricted RichText features, add `ai` to your list of features.
* By default, Wagtail will include all registered features on `RichTextField` and `RichTextBlock` instances. However, [features can be restricted](https://docs.wagtail.org/en/stable/advanced_topics/customisation/page_editing_interface.html#limiting-features-in-a-rich-text-field).
* If you've restricted features, you must add `ai` to the list of features for the Wagtail AI button to appear on RichText fields/blocks.

0 comments on commit a14a677

Please sign in to comment.