From bc4f9afac54727adbd1930c3efae2b1889bc3f98 Mon Sep 17 00:00:00 2001 From: Jeremiah Lowin <153965+jlowin@users.noreply.github.com> Date: Mon, 23 Sep 2024 19:28:23 -0400 Subject: [PATCH] Add version badges --- docs/guides/default-memory.mdx | 2 ++ docs/patterns/memory.mdx | 3 +++ docs/snippets/version-badge.mdx | 9 +++++++++ docs/style.css | 18 ++++++++++++++++++ 4 files changed, 32 insertions(+) create mode 100644 docs/snippets/version-badge.mdx create mode 100644 docs/style.css diff --git a/docs/guides/default-memory.mdx b/docs/guides/default-memory.mdx index 44ae38c1..fe74f18f 100644 --- a/docs/guides/default-memory.mdx +++ b/docs/guides/default-memory.mdx @@ -4,7 +4,9 @@ sidebarTitle: Default Memory Provider description: Set up a default persistent memory provider for your agents icon: brain --- +import { VersionBadge } from '/snippets/version-badge.mdx' + ControlFlow's [memory](/patterns/memory) feature allows agents to store and retrieve information across multiple workflows. Memory modules are backed by a vector database, configured using a `MemoryProvider`. Setting up a default provider simplifies the process of creating memory objects throughout your application. Once configured, you can create memory objects without specifying a provider each time. diff --git a/docs/patterns/memory.mdx b/docs/patterns/memory.mdx index 4186668c..4942a5d9 100644 --- a/docs/patterns/memory.mdx +++ b/docs/patterns/memory.mdx @@ -3,8 +3,11 @@ title: Memory description: Enhance your agents with persistent memories. icon: bookmark --- +import { VersionBadge } from '/snippets/version-badge.mdx' + + Within an agentic workflow, information is naturally added to the [thread history](/patterns/history) over time, making available to all agents who participate in the workflow. However, that information is not accessible from other threads, even if they relate to the same objective or resources. diff --git a/docs/snippets/version-badge.mdx b/docs/snippets/version-badge.mdx new file mode 100644 index 00000000..c3d8e2b4 --- /dev/null +++ b/docs/snippets/version-badge.mdx @@ -0,0 +1,9 @@ +export const VersionBadge = ({ version }) => { + + + return ( + + Added in version {version} + + ); +}; \ No newline at end of file diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 00000000..90edfa88 --- /dev/null +++ b/docs/style.css @@ -0,0 +1,18 @@ +.version-badge { + display: inline-block; + padding: 0.2em 0.5em; + font-size: 0.75em; + font-weight: bold; + color: #e44bf4; + background-color: #fce8fd; + border: 1px solid #f2a5f9; + border-radius: 4px; + vertical-align: middle; + margin-left: 0.5em; +} + +.dark .version-badge { + color: #f17afc; + background-color: rgba(228, 75, 244, 0.2); + border-color: #783d7e; +}