doc updates

Makefile

@@ -1,4 +1,4 @@
-publish: publish-openassistants publish-openassistants-fastapi publish-openassistants-ui
+publish: publish-openassistants publish-openassistants-fastapi publish-openassistants-react
 	@echo "All packages published!"
 
 publish-openassistants:
@@ -9,9 +9,9 @@ publish-openassistants-fastapi:
 	@echo "Publishing openassistants-fastapi to PyPI..."
 	@cd packages/openassistants-fastapi && poetry publish --build
 
-publish-openassistants-ui:
-	@echo "Publishing openassistants-ui to npm..."
-	@cd packages/openassistants-ui && npm publish
+publish-openassistants-react:
+	@echo "Publishing openassistants-react to npm..."
+	@cd packages/openassistants-react && npm publish
 
 refresh-poetry:
 	@echo "Refreshing Poetry environment..."

README.md

@@ -3,16 +3,15 @@
 [![Documentation](https://img.shields.io/badge/docs-openassistants-blue.svg)](https://definitive-io.github.io/openassistants/)
 [![OpenAssistants PyPI](https://img.shields.io/pypi/v/definitive-openassistants.svg)](https://pypi.org/project/definitive-openassistants/)
 [![OpenAssistants-FastAPI PyPI](https://img.shields.io/pypi/v/definitive-openassistants-fastapi.svg)](https://pypi.org/project/definitive-openassistants-fastapi/)
-[![npm version](https://img.shields.io/npm/v/@definitive-io/openassistants-ui)](https://www.npmjs.com/package/@definitive-io/openassistants-ui)
+[![npm version](https://img.shields.io/npm/v/@definitive-io/openassistants-react)](https://www.npmjs.com/package/@definitive-io/openassistants-react)
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 [![Discord](https://img.shields.io/discord/1182644873992613989.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/Snd4Cry7wD)
 
-
 OpenAssistants is a collection of open source libraries aimed at developing robust AI assistants rather than autonomous agents. By focusing on specific tasks and incorporating human oversight, OpenAssistants strives to minimize error rates typically found in agentic systems.
 
 - `openassistants` the core library responsible for the main function calling / message generating runtime
 - `openassistants-fastapi` a set of FastAPI routes used for interacting with the core runtime loop through a REST API
-- `openassistants-ui` an example chat client that supports rich streaming outputs like tables, plots, form inputs and text.
+- `openassistants-react` an example chat client that supports rich streaming outputs like tables, plots, form inputs and text.
 
 OpenAssistants is built on [LangChain](https://github.com/langchain-ai/langchain) and designed to be an open alternative to OpenAI's [Assistants API](https://platform.openai.com/docs/assistants/overview). We also think it's easier to use!
 
@@ -21,6 +20,7 @@ OpenAssistants is built on [LangChain](https://github.com/langchain-ai/langchain
 Join us in creating AI assistants that are not only useful but dependable for production use today.
 
 ## Features
+
 - Included Chat UI
 - Support function calling with any LLM (open source & proprietary)
 - Declarative library of functions
@@ -39,15 +39,30 @@ Join us in creating AI assistants that are not only useful but dependable for pr
 
 To run the project locally:
 
+### Api Server
+
 - Navigate to `examples/fast-api-server` to start the **backend** example:
+
   - Run `poetry install`
   - Activate the virtual environment with `poetry shell`
   - Set OPENAI_API_KEY env var with `export OPENAI_API_KEY=sk-my-key`
   - Start the server with `./run.sh`
 
-- Then, go to `examples/next` to start the **frontend** example:
-  - Install dependencies with `yarn install`
-  - Launch the development server with `yarn dev`
-  - Access the application at `localhost:3000`
+## Frontend
+
+- From the root, run `yarn install`
+- Navigate to the sample next app`cd examples/next`
+- Launch the development server with `yarn dev`
+- Access the application at `localhost:3000`
 
 Join our community and start contributing today!
+
+## Local development
+
+To develop the UI library locally, youll also want to compile in watch for hot reloading.
+In a new terminal window
+
+- navigate to the component library `cd packages/openassistants-react`
+- run the compiler in watch mode `yarn start`
+
+Now any changes to the library will also get picked and displayed in your process running the next app

docs/blog/2023-12-8-assistants-not-agents/index.md

@@ -35,7 +35,7 @@ We're launching with three packages:
 
 - `openassistants` the core library responsible for the main function calling / message generating runtime
 - `openassistants-fastapi` a set of FastAPI routes used for interacting with the core runtime loop through a REST API
-- `openassistants-ui` an example chat client that supports rich streaming outputs like tables, plots, form inputs and text.
+- `openassistants-react` an example chat client that supports rich streaming outputs like tables, plots, form inputs and text.
 
 The project is built on top of LangChain and we will soon support more sophisticated RAG features based on LlamaIndex. Our goal is to be the open alternative to the AssistantsAPI that can operate against any LLM: both Open Source LLMs like fine-tuned Llama's focused on function calling and proprietary models with e.g. native support for function calling.
 

examples/next/tsconfig.json

@@ -24,12 +24,6 @@
       ]
     }
   },
-  "include": [
-    "next-env.d.ts",
-    "**/*.ts",
-    "**/*.tsx",
-    ".next/types/**/*.ts",
-    "**/*.css"
-  ],
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
   "exclude": ["node_modules"]
 }