Skip to content

Commit c4cb5c4

Browse files
committed
docs: add more notes to /prompts
1 parent 29c7408 commit c4cb5c4

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

pages/docs/prompts.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ description: Manage and version your prompts in Langfuse (open source). When ret
44

55
# Prompt Management
66

7+
Use Langfuse to effectively **manage** and **version** your prompts. Langfuse prompt management is basically a **Prompt CMS** (Content Management System).
8+
9+
## How it works
10+
11+
1. **Create/update** prompts via Langfuse API/SDKs or Console.
12+
2. **Use** prompts at runtime, always get the latest version (cached by Langfuse SDKs for low latency).
13+
3. _Optionally_, promote a specific version of a prompt to production or quickly rollback to a previous version.
14+
15+
## Why use prompt management?
16+
17+
Typical benefits of using a CMS apply here:
18+
19+
- Decoupling: deploy new prompts without redeploying your application.
20+
- Non-technical users can create and update prompts via Langfuse Console.
21+
- Quickly rollback to a previous version of a prompt.
22+
- Link prompts to Langfuse Tracing to monitor their performance.
23+
24+
## Get Started
25+
726
import { Terminal, FileCode } from "lucide-react";
827

928
<Cards num={2}>

pages/docs/prompts/get-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Manage and version your prompts in Langfuse (open source). When ret
55
import { Callout } from "nextra-theme-docs";
66
import { CloudflareVideo } from "@/components/Video";
77

8-
# Prompt Management
8+
# Get Started with Prompt Management
99

1010
Use Langfuse to effectively manage and version your prompts. This allows you to iterate quickly, publish new prompt versions without redeploying your app, and track metrics by prompt version.
1111

@@ -73,13 +73,13 @@ const promptTemplate = PromptTemplate.fromTemplate(
7373
The workflow for managing prompts in Langfuse includes the following steps:
7474

7575
```mermaid
76-
graph LR
76+
graph TB
7777
A["1. Create new prompt version (SDK or UI)"] --> PV
7878
subgraph S1["Prompt (identified by name)"]
7979
PV["Prompt Version"] -->|"2. Promote"| PP["Production Prompt"]
8080
end
8181
PP --> D["3. Retrieve prompt using SDK"]
82-
PP --> E["4. View metrics in Langfuse for prompt version"]
82+
PP --> E["4. View metrics in Langfuse UI"]
8383
```
8484

8585
## Prompt object

0 commit comments

Comments
 (0)