Updated Chat Assistant and Social Post Generator tutorials #629

AccordionGuy · 2024-11-13T15:43:07Z

I’ve updated the Chat Assistant and Social Post Generator tutorials based on @ajot’s and @samjulien’s revisions, as requested in this Jira ticket.

samjulien

These are great and like 85% of the way there. I stepped through the chat one and left notes, and then read through the social post one and left more notes.

I've run out of time to go through the social one one step by step. You can apply basically all of the suggestions for the chat assistant one to this one (e.g. linking to guides, etc) and then tag @ajot to step through the social post one.

samjulien · 2024-11-13T18:49:12Z

docs/framework/chat-assistant.mdx

+- **A Writer account:** Create a free account at [writer.com](https://writer.com).
+- **Python 3.7+**: Use the installer from [python.org](https://www.python.org/downloads/).
+- **pip:** This command-line application comes with Python and is used for installing Python packages, including those from Writer.
+- **Your favorite code editor:** You'll need one — such as Visual Studio Code, Notepad++, Vim, Emacs, or any text editor made for programming — to write the back-end code behind the user interface.


Let's note that the code editor is optional since you can use the in-browser one

samjulien · 2024-11-13T18:50:01Z

docs/framework/chat-assistant.mdx

+
+Before starting, ensure you have:
+
+- **A Writer account:** Create a free account at [writer.com](https://writer.com).


This should be a link to the Writer AI Studio signup: https://app.writer.com/aistudio/signup.

samjulien · 2024-11-13T18:53:19Z

docs/framework/chat-assistant.mdx

-    ```bash Standard port
-    writer edit chat-assistant
-    ```
+  <Step title="Create a .env file">


Let's add a note that if they are using the in-browser code editor, they can instead export the key in their terminal session.

Updated. I decided to keep the tutorial simple by skipping the .env file entirely and simply exporting the key to their terminal session.

samjulien · 2024-11-13T18:54:17Z

docs/framework/social-post-generator.mdx

+
+Before starting, ensure you have:
+
+- **A Writer account:** Create a free account at [writer.com](https://writer.com).


Ditto on Writer AI Studio signup/text https://app.writer.com/aistudio/signup

samjulien · 2024-11-13T18:54:37Z

docs/framework/social-post-generator.mdx

+- **A Writer account:** Create a free account at [writer.com](https://writer.com).
+- **Python 3.7+**: Use the installer from [python.org](https://www.python.org/downloads/).
+- **pip:** This command-line application comes with Python and is used for installing Python packages, including those from Writer.
+- **Your favorite code editor:** You'll need one — such as Visual Studio Code, Notepad++, Vim, Emacs, or any text editor made for programming — to write the back-end code behind the user interface.


Ditto on this being optional and point out the in-browser editor as an option

samjulien · 2024-11-13T21:32:04Z

docs/framework/chat-assistant.mdx

-    This code uses the streaming function of the `Conversation` method, which is a wrapper for the `chat` API endpoint. Each chunk returned from the stream is added to the `conversation` variable in the application state.
+    The `generate_completion()` function will be called when the user enters a prompt, which is contained in the `payload` object. The `payload` object is  added to the `conversation` object contained in the application's `state`, which adds the user's prompt to the record of the conversation between the user and the LLM.
+
+    After adding the user's prompt to the conversational record, `generate_completion()` calls the `conversation` object's `stream_complete()` method, which generates an LLM completion based on the conversation so far. As its name implies, `stream_complete()` returns the completion as a stream of text chunks, which are captured and added to the `conversation` object.


Let's link to the AI module guide at the end of this if people want to learn more, for example if they want to learn more.

samjulien · 2024-11-13T21:34:46Z

docs/framework/chat-assistant.mdx

+  ```python
+  # Initialize the state
+  wf.init_state({
+      "conversation": writer.ai.Conversation(),


It might be worth calling out here that you can pass configuration into this such as what model you want to use and then link to the AI module guide.

samjulien · 2024-11-13T21:36:18Z

docs/framework/chat-assistant.mdx


-![Finished chat assistant project](/framework/images/tutorial/chat/chat_assistant_6.png)
+The application is ready to run locally!


Let's make sure that it's clear somewhere in this tutorial and at this part that you can always see the running application using the "Preview" button at the top. As a reader I'd be wondering:

Why do I have to quit and re-run it in order to see my changes?

What's the difference between writer edit Preview and writer run

Let's answer those questions here.

samjulien · 2024-11-13T21:38:07Z

docs/framework/chat-assistant.mdx

+
+  ```python
+  def generate_completion(state, payload):
+    print(f"Here's what the user entered: {payload['content']}")


I love all of the print statements here for debugging, but you can just call it out in the para below? Something about how there are some optional print statements in there to help with debugging, feel free to remove them.

samjulien · 2024-11-13T21:44:07Z

docs/framework/social-post-generator.mdx

@@ -2,218 +2,410 @@
 title: "Social post generator"


I've run out of time to go through this one step by step, but you could apply basically all of the suggestions for the chat assistant one to this one (e.g. linking to guides, etc) and then tag @ajot to step through the social post one.

samjulien

Just a few image issues but everything else is looking good!

samjulien · 2024-11-26T20:49:41Z

docs/framework/images/tutorial/chat/chat_assistant_2f.png

@AccordionGuy can you retake this so you don't see the cursor in the corner?

samjulien · 2024-11-26T20:49:51Z

docs/framework/images/tutorial/social_post/sp_gen_2e.png

@AccordionGuy can you retake this so you don't see the cursor in the corner?

samjulien · 2024-11-26T20:50:00Z

docs/framework/images/tutorial/social_post/sp_gen_2g.png

@AccordionGuy can you retake this so you don't see the cursor in the corner?

samjulien · 2024-11-26T20:50:10Z

docs/framework/images/tutorial/chat/chat_assistant_2e.png

@AccordionGuy can you retake this so you don't see the cursor in the corner?

samjulien · 2024-11-26T20:50:52Z

docs/framework/images/tutorial/chat/chat_assistant_2b.png

@AccordionGuy can you retake this so you don't see the cursor in the corner?

samjulien · 2024-11-26T20:52:22Z

docs/framework/social-post-generator.mdx


+![The working social post generator, with the project editor in "Preview" mode and the log pane displayed](/framework/images/tutorial/chat/chat_assistant_2g.png)


@AccordionGuy this image isn't displaying for me, may need to double-check it

AccordionGuy · 2024-11-27T23:17:01Z

@ramedina86 I’ve updated the Chat assistant and Social post generator tutorials as requested by @samjulien. I’ve made the final changes and they’re ready to be published.

ramedina86 · 2024-12-02T16:50:48Z

docs/framework/social-post-generator.mdx

+
+There are two ways to edit `main.py`:
+
+1. **In your browser.** Click on the **Code** button near the top right corner of the project editor page. A pane with the name **Code**  will appear at the bottom half of the screen, displaying and allowing you to edit the contents of `main.py`.


near the top right corner

When updating screenshots, please make sure that these references are also updated.

ramedina86 · 2024-12-02T16:52:44Z

docs/framework/social-post-generator.mdx

+
+Before starting, ensure you have:
+
+- **A Writer account:** You'll need an account to use Writer Framework, and [you can sign up for a free one](https://app.writer.com/aistudio/signup).


You'll need an account to use Writer Framework

Can we change this? In fact, we should start emphasizing everywhere that you don't need a Writer account to use Writer Framework, only to use Writer's AI features which are accessible via the Framework.

Ah good catch @ramedina86 -- yes @AccordionGuy let's say something like "You'll need an account to use the AI module in Writer Framework"

Oh, be sure to do it in both tutorials too

AccordionGuy · 2024-12-03T06:12:48Z

@samjulien @ramedina86 I’ve made the updates — new screenshots and confirmed that the text matches the updated UI.

Updated Chat Assistant and Social Post Generator tutorials

5537bc4

samjulien suggested changes Nov 13, 2024

View reviewed changes

AccordionGuy added 2 commits November 19, 2024 15:01

Update requirements - code editor is optional

ae1381a

Additional updates based on Sam's review

c320c26

samjulien suggested changes Nov 26, 2024

View reviewed changes

Fixes to screenshots

2d9f481

ramedina86 reviewed Dec 2, 2024

View reviewed changes

AccordionGuy added 2 commits December 3, 2024 01:03

Updates for 0.8.1 interface

5623afb

Minor text fixes

2a2e4ab

ramedina86 merged commit a041f1a into writer:dev Dec 3, 2024
15 checks passed


		Before starting, ensure you have:

		- A Writer account: Create a free account at [writer.com](https://writer.com).


		![Finished chat assistant project](/framework/images/tutorial/chat/chat_assistant_6.png)
		The application is ready to run locally!


		![The working social post generator, with the project editor in "Preview" mode and the log pane displayed](/framework/images/tutorial/chat/chat_assistant_2g.png)


		There are two ways to edit `main.py`:

		1. In your browser. Click on the Code button near the top right corner of the project editor page. A pane with the name Code will appear at the bottom half of the screen, displaying and allowing you to edit the contents of `main.py`.


		Before starting, ensure you have:

		- A Writer account: You'll need an account to use Writer Framework, and [you can sign up for a free one](https://app.writer.com/aistudio/signup).

Updated Chat Assistant and Social Post Generator tutorials #629

Updated Chat Assistant and Social Post Generator tutorials #629

Conversation

AccordionGuy commented Nov 13, 2024

samjulien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

samjulien left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AccordionGuy commented Nov 27, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AccordionGuy commented Dec 3, 2024