From 2ab1234987008c46841d5f17b1e06f5263978b40 Mon Sep 17 00:00:00 2001 From: elijahbenizzy Date: Wed, 17 Apr 2024 16:26:38 -0700 Subject: [PATCH] Adds better text for simple examples --- docs/examples/chatbot.rst | 2 ++ docs/examples/simple.rst | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/examples/chatbot.rst b/docs/examples/chatbot.rst index 3b758f45..10beeb07 100644 --- 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 index f97dfbbc..dfee5a37 100644 --- 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 `. + - `cowsay `_ - `counter `_ -- `[corgi] adventure game `_ +- `corgi adventure game `_