From d4258971a0fa30db6f8059a357e9dce475a0aeb3 Mon Sep 17 00:00:00 2001 From: Jim Birch Date: Tue, 8 Oct 2024 09:49:40 -0400 Subject: [PATCH] Updates instructions --- README.md | 96 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 74 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 47be721..9569ee4 100644 --- a/README.md +++ b/README.md @@ -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.