-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
16 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,19 @@ | ||
# Documentation | ||
# Silverstripe SEO AI Module | ||
|
||
Add your documentation in the `docs/en/` folder as markdown. Note the "en/" part of the path refers to the language (English in this case) used in the documentation you provide. | ||
If your documentation is vast, you can split it into many markdown files and sub folders. | ||
## Installation | ||
``` composer require "plasticstudio/silverstripe-seo-ai" ``` | ||
|
||
Look over the [guidance on documentation](https://docs.silverstripe.org/en/contributing/documentation/) | ||
## Setting Up | ||
After installing the module, configure the API and model / temperature settings via YAML. | ||
|
||
Make sure to remove this readme in your actual module! | ||
``` | ||
--- | ||
Name: silverstripe-seo-ai | ||
--- | ||
SilverStripe\Core\Injector\Injector: | ||
PlasticStudio\SEOAI\Extensions\SeoAICMSPageEditControllerExtension: | ||
properties: | ||
openaiKey: "`OPENAI_API_KEY`" | ||
model: "gpt-4o-mini" | ||
temperature: 0 | ||
``` |