From 9a004a054a7cc7847471e92141cbdbf92133ba2a Mon Sep 17 00:00:00 2001 From: quietdom Date: Tue, 9 Jun 2026 17:23:54 +0400 Subject: [PATCH] docs: fix multiple typos and broken code examples MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Fix typo: 'too' → 'to' in README.md - Fix code bug: response=content → response=response in README.md - Fix grammar: 'use view' → 'use to view' in README.md - Fix typo: 'asynchonous' → 'asynchronous' in actions.rst - Fix missing colon on function signature in actions.rst - Fix missing closing quote in state-persistence.rst - Fix markdown link syntax to RST in install.rst - Fix garbled command name in simple-example.rst - Fix typo: 'lifeycyle' → 'lifecycle' in up-next.rst Closes #725 --- README.md | 6 +++--- docs/concepts/actions.rst | 4 ++-- docs/concepts/state-persistence.rst | 2 +- docs/getting_started/install.rst | 2 +- docs/getting_started/simple-example.rst | 2 +- docs/getting_started/up-next.rst | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index f7b177294..97bbd8f27 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ burr ``` This will open up Burr's telemetry UI. It comes loaded with some default data so you can click around. -It also has a demo chat application to help demonstrate what the UI captures enabling you too see things changing in +It also has a demo chat application to help demonstrate what the UI captures enabling you to see things changing in real-time. Hit the "Demos" side bar on the left and select `chatbot`. To chat it requires the `OPENAI_API_KEY` environment variable to be set, but you can still see how it works if you don't have an API key set. @@ -94,7 +94,7 @@ def ai_response(state: State) -> State: # query the LLM however you want (or don't use an LLM, up to you...) response = _query_llm(state["chat_history"]) # Burr doesn't care how you use LLMs! chat_item = {"role" : "system", "content" : response} - return state.update(response=content).append(chat_history=chat_item) + return state.update(response=response).append(chat_history=chat_item) app = ( ApplicationBuilder() @@ -113,7 +113,7 @@ print("answer:", app.state["response"]) Apache Burr includes: 1. A (dependency-free) low-abstraction python library that enables you to build and manage state machines with simple python functions -2. A UI you can use view execution telemetry for introspection and debugging +2. A UI you can use to view execution telemetry for introspection and debugging 3. A set of integrations to make it easier to persist state, connect to telemetry, and integrate with other systems ![Burr at work](https://github.com/apache/burr/blob/main/chatbot.gif) diff --git a/docs/concepts/actions.rst b/docs/concepts/actions.rst index 30bf70957..c8809411d 100644 --- a/docs/concepts/actions.rst +++ b/docs/concepts/actions.rst @@ -26,7 +26,7 @@ Actions .. note:: Actions are the core building block of Burr. They read from state and write to state. - They can be synchronous and asynchonous, and have both a ``sync`` and ``async`` API. + They can be synchronous and asynchronous, and have both a ``sync`` and ``async`` API. There are both function and class-based APIs. @@ -96,7 +96,7 @@ above is equivalent to returning an empty dictionary instead of the results. from burr.core import action, State @action(reads=["var_from_state"], writes=["var_to_update"]) - def custom_action(state: State) -> State + def custom_action(state: State) -> State: return results, state.update(var_to_update=var_from_state + 1) app = ApplicationBuilder().with_actions( diff --git a/docs/concepts/state-persistence.rst b/docs/concepts/state-persistence.rst index cff0e6284..e6b38ffb8 100644 --- a/docs/concepts/state-persistence.rst +++ b/docs/concepts/state-persistence.rst @@ -271,7 +271,7 @@ tracked runs. This is useful for debugging, or building an application that enab tracker, resume_at_next_action=True, default_state={"chat_history" : []}, - default_entrypoint="human_converse + default_entrypoint="human_converse" ) .with_tracker(tracker) .with_identifiers(app_id=app_id) diff --git a/docs/getting_started/install.rst b/docs/getting_started/install.rst index 0f716c146..fdbdabe90 100644 --- a/docs/getting_started/install.rst +++ b/docs/getting_started/install.rst @@ -33,7 +33,7 @@ along with a fully built server. This will give you tools to visualize, track, and interact with the UI. You can explore the UI (including some sample projects) simply by running the command ``burr``. Up next we'll write our own application and follow it in the UI. -If you're using poetry, you can't install the ``start`` target directly, due to [this issue](https://github.com/python-poetry/poetry/issues/3369). +If you're using poetry, you can't install the ``start`` target directly, due to `this issue `_. Instead, please install manually using the following command: .. code-block:: bash diff --git a/docs/getting_started/simple-example.rst b/docs/getting_started/simple-example.rst index 774275639..e77fb432c 100644 --- a/docs/getting_started/simple-example.rst +++ b/docs/getting_started/simple-example.rst @@ -222,4 +222,4 @@ Now that we've built a basic application, we can do the following with only a fe 2. :ref:`Persist state to a database + reload ` -- add a ``initialize_from`` line to the builder and select a pre-existing/implement a custom persistence method. 3. :ref:`Add monitoring to track application data ` -- leverage ``with_tracker`` to track to the Burr UI and visualize your application live. 4. :ref:`Stream results back ` -- minimize time to first token by streaming results back to the user. -5. `Generate test cases from prior runs `_ -- use the ``burr-testburr-test-case create`` command to automatically generate test cases for your LLM app. +5. `Generate test cases from prior runs `_ -- use the ``burr-test-case create`` command to automatically generate test cases for your LLM app. diff --git a/docs/getting_started/up-next.rst b/docs/getting_started/up-next.rst index bcf12af91..a94d0d19f 100644 --- a/docs/getting_started/up-next.rst +++ b/docs/getting_started/up-next.rst @@ -88,7 +88,7 @@ Once you're comfortable with the UI, you may want to get a sense of a few of the of the Burr library and where you can go to learn more about them: - :ref:`Creating custom actions ` and calling out to integrated frameworks -- :ref:`Running applications `, managing their lifeycyle, and inspecting the results +- :ref:`Running applications `, managing their lifecycle, and inspecting the results - :ref:`Managing state ` -- persisting, inspecting, and updating - :ref:`Handling transition between nodes ` and managing the flow of your application - :ref:`Adding hooks to customize execution ` and integrate with other systems