Skip to content

Commit

Permalink
Updates instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
thejimbirch committed Oct 8, 2024
1 parent 444bb09 commit d425897
Showing 1 changed file with 74 additions and 22 deletions.
96 changes: 74 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,56 +33,108 @@ it will get cloned on subsequent multidev clones.

## Usage

To use the configured AI tools, start by clicking the *AI Assistant* button in any
Full HTML CKEditor instance.
To use the configured AI tools, start by clicking the *AI Assistant* button in
any Full HTML CKEditor instance.

### Generate with AI

When you click the AI Assistant button > Generate with AI option, a modal pops
up presenting:

- What would you like to ask or get ideas for?
> What would you like to ask or get ideas for?
Enter your prompt to AI to help you write your content.
Example: Write three paragraphs about Kanopi Studio's Saplings suite of Recipes.
- Enter your prompt to AI to help you write your content.

- After you have written your prompt, click the *Generate* button. You can click
the button multiple times to get different responses from the AI source.
Example: Write three paragraphs about Kanopi Studio's Saplings suite of
Recipes.

- After you have written your prompt, click the *Generate* button.

You can click the button multiple times to get different responses from the AI
source.

After you click the Generate button, below the *Response from AI* field, you
will see the *AI Writer: Idle* message switch to
*AI Writer: Waiting for response*.

- After you click the button, below the *Response from AI* field, you will see
the *AI Writer: Idle* message switch to *AI Writer: Waiting for response*.
Once the AI action has completed, it will switch back to Idle.

- The response is saved in the *Response from AI* field. You can edit the
response before saving it back to the main editor.
- The response is saved in the *Response from AI* field.

You can edit the response before saving it back to the main editor.

- When you are satisfied with the content, click the *Save changes to editor*
When you are satisfied with the content, click the *Save changes to editor*
button.

- Be sure to click *Save* on your node/page to ensure your changes are saved.

### Summarize with AI
### Summarize

- Select text in CKEditor
- Click the AI Assistant button, then select *Summarize with AI*
- Select text in CKEditor.

- Click the AI Assistant button, then select *Summarize*.

- Click the *Summarize* button.

After you click the Summarize button, below the *Response from AI* field, you
will see the *AI Writer: Idle* message switch to
*AI Writer: Waiting for response*.

- After you click the button, below the *Response from AI* field, you will see
the *AI Writer: Idle* message switch to *AI Writer: Waiting for response*.
Once the AI action has completed, it will switch back to Idle.

- The response is saved in the *Response from AI* field. You can edit the
response before saving it back to the main editor.
- The response is saved in the *Response from AI* field.

You can edit the response before saving it back to the main editor.

- When you are satisfied with the content, click the *Save changes to editor*
When you are satisfied with the content, click the *Save changes to editor*
button.

- Be sure to click *Save* on your node/page to ensure your changes are saved.

### Tone

@TODO
- Select text in CKEditor.

- Click the AI Assistant button, then select *Tone*.

- Select the Tone you want to rewrite your content in, then click the *Generate*
button.

After you click the Generate button, below the *Response from AI* field, you
will see the *AI Writer: Idle* message switch to
*AI Writer: Waiting for response*.

Once the AI action has completed, it will switch back to Idle.

- The response is saved in the *Response from AI* field.

You can edit the response before saving it back to the main editor.

When you are satisfied with the content, click the *Save changes to editor*
button.

- Be sure to click *Save* on your node/page to ensure your changes are saved.

### Translate

@TODO
- Select text in CKEditor.

- Click the AI Assistant button, then select *Translate*.

- Select or add the Language you want to rewrite your content in, then click the
*Translate* button.

After you click the Translate button, below the *Response from AI* field, you
will see the *AI Writer: Idle* message switch to
*AI Writer: Waiting for response*.

Once the AI action has completed, it will switch back to Idle.

- The response is saved in the *Response from AI* field.

You can edit the response before saving it back to the main editor.

When you are satisfied with the content, click the *Save changes to editor*
button.

- Be sure to click *Save* on your node/page to ensure your changes are saved.

0 comments on commit d425897

Please sign in to comment.