Skip to content

armgit / burr

Public Imported from GitHub
0

Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.

Updates documentation

Stefan Krawczyk47e034491c49
diff --git a/README.md b/README.md
index d5515f20..65bbbb1d 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,13 @@
# Burr
+<div>
+<a href="https://discord.gg/6Zy2DwP4f3" target="_blank"><img src="https://img.shields.io/badge/Join-Burr_Discord-brightgreen?logo=discord" alt="Burr Discord"/></a>
+</div>
Burr makes it easy to develop applications that make decisions based on state (chatbots, agents, simulations, etc...) from simple python building blocks.
Burr includes a UI that can track/monitor those decisions in real time.
-Link to [documentation](https://burr.dagworks.io/). Quick video intro [here](https://www.loom.com/share/a10f163428b942fea55db1a84b1140d8?sid=1512863b-f533-4a42-a2f3-95b13deb07c9). Blog post [here](https://blog.dagworks.io/p/burr-develop-stateful-ai-applications).
+Link to [documentation](https://burr.dagworks.io/). Quick (<3min) video intro [here](https://www.loom.com/share/a10f163428b942fea55db1a84b1140d8?sid=1512863b-f533-4a42-a2f3-95b13deb07c9).
+Longer [intro & walkthrough](https://www.youtube.com/watch?v=rEZ4oDN0GdU). Blog post [here](https://blog.dagworks.io/p/burr-develop-stateful-ai-applications).
## 🏃Quick start
diff --git a/docs/getting_started/simple-example.rst b/docs/getting_started/simple-example.rst
index ca4a41d0..ffcdd4c8 100644
--- a/docs/getting_started/simple-example.rst
+++ b/docs/getting_started/simple-example.rst
@@ -10,6 +10,10 @@ ML training, simulations, etc...) feel free to jump into the deep end and start
We will go over enough of the concepts to help you understand the code, but there is a much more in-depth set of
explanations in the :ref:`concepts <concepts>` section.
+🤔 For an alternative example to get started with, you can also check out
+`this video walkthrough <https://www.youtube.com/watch?v=rEZ4oDN0GdU>`_
+using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/blog_post/blog.ipynb>`_.
+
------------------
Build a Counter
------------------
diff --git a/docs/index.rst b/docs/index.rst
index 86caefb2..aee4f31a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -15,6 +15,12 @@
examples/index
+.. toctree::
+ :hidden:
+ :caption: Community
+
+ Discord Server <https://discord.gg/6Zy2DwP4f3>
+
.. toctree::
:hidden:
:maxdepth: 2
diff --git a/docs/main.rst b/docs/main.rst
index f117e055..5795e903 100644
--- a/docs/main.rst
+++ b/docs/main.rst
@@ -4,9 +4,15 @@ Burr
Welcome to Burr's documentation.
-For a quick overview, watch the following video (<2 minutes). If you prefer long-form,
-see the `original launch post <https://blog.dagworks.io/p/burr-develop-stateful-ai-applications>`_.
+For an overview of Burr, watch `this video walkthrough <https://www.youtube.com/watch?v=rEZ4oDN0GdU>`_ of building a simple
+Burr application (using `this notebook <https://github.com/DAGWorks-Inc/burr/blob/main/examples/blog_post/blog.ipynb>`_),
+or read `our blog post <https://blog.dagworks.io/p/burr-develop-stateful-ai-applications?r=2cg5z1&utm_campaign=post&utm_medium=web>`_:
+.. raw:: html
+
+ <div style="position: relative; padding-bottom: 56.25%; height: 0;"><iframe width="800" height="455" src="https://www.youtube.com/embed/rEZ4oDN0GdU?si=6RvExhQVsAyNd8Ts" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div>
+
+For a quicker overview, watch the following video (<2 minutes).
.. raw:: html
diff --git a/pyproject.toml b/pyproject.toml
index 3d01cca0..dd4a75eb 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -62,6 +62,7 @@ documentation = [
"sphinx-sitemap",
"sphinx-toolbox",
"psycopg2-binary",
+ "redis",
]
tracking-client = [