Adds better text for simple examples

DAGWorks-Inc · Apr 17, 2024 · 2ab1234 · 2ab1234
1 parent 32c4bd1
commit 2ab1234
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/docs/examples/chatbot.rst b/docs/examples/chatbot.rst
@@ -2,6 +2,8 @@
 Chatbots
 ================
 
+.. _chatbots:
+
 Chat bots are a simple example where state influences the conversation. This is a
 perfect use case for using Burr.
 

diff --git a/docs/examples/simple.rst b/docs/examples/simple.rst
@@ -2,6 +2,10 @@
 Simple examples
 ====================
 
+The following are all simple examples to give you a sense of how to use Burr. They're mostly toy-examples
+but they show a few concepts. If you're interested in more real-life applications, skip ahead to
+:ref:`state-persistence <chatbots>`.
+
 - `cowsay <https://github.com/DAGWorks-Inc/burr/tree/main/examples/other-examples/cowsay>`_
 - `counter <https://github.com/DAGWorks-Inc/burr/tree/main/examples/hello-world-counter>`_
-- `[corgi] adventure game <https://github.com/DAGWorks-Inc/burr/tree/main/examples/llm-adventure-game>`_
+- `corgi adventure game <https://github.com/DAGWorks-Inc/burr/tree/main/examples/llm-adventure-game>`_