Skip to content

Commit 60ef841

Browse files
committed
docs: sequence diagram img
1 parent d498fac commit 60ef841

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

docs/prompt_engineering/tutorials/prompt_commit.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,8 @@ Once your FastAPI server is deployed and you have its public URL, you can config
408408

409409
## The Workflow in Action
410410

411+
![Workflow Diagram showing: User saves prompt in LangSmith, LangSmith sends webhook to FastAPI Server, which interacts with GitHub to update files](./static/prompt-sequence-diagram.png)
412+
411413
Now, with everything set up, here's what happens:
412414

413415
1. **Prompt Modification:** A user (developer or non-technical team member) modifies a prompt in the LangSmith UI and saves it, creating a new "prompt commit."
@@ -417,7 +419,7 @@ Now, with everything set up, here's what happens:
417419
5. **GitHub Commit:** The server parses the JSON manifest from the request body. It then uses the configured GitHub Personal Access Token, repository owner, repository name, file path, and branch to:
418420
* Check if the manifest file already exists in the repository on the specified branch to get its SHA (this is necessary for updating an existing file).
419421
* Create a new commit with the latest prompt manifest, either creating the file or updating it if it already exists. The commit message will indicate that it's an update from LangSmith.
420-
6. **Confirmation:** Your server sends a success response back to LangSmith. You should see the new commit appear in your GitHub repository.
422+
6. **Confirmation:** You should see the new commit appear in your GitHub repository.
421423

422424
![Manifest commited to Github](./static/prompt-commit-github.png)
423425

Loading

0 commit comments

Comments
 (0)