Merge pull request #299 from lisa-jwayela/for-new-users

Updates for new users getting started with teams and LLM API keys

Author: snopoke

docs/about.md

@@ -6,4 +6,4 @@ hide:
 
 [Dimagi](https://dimagi.com/) is developing Open Chat Studio (OCS) as an easy-to-use, open source platform for rapidly prototyping and testing chatbots created using Large Language Models (LLMs). Open Chat Studio makes it easy to develop and test LLM-based chatbots, and to instill a variety of guardrails to improve the safety and accuracy of these bots.
 
-Open Chat Studio can work with any LLM with an API such as the [OpenAI Chat Completions API](https://platform.openai.com/docs/guides/text-generation).
+Open Chat Studio can work with any LLM with an API such as the [OpenAI Responses API](https://platform.openai.com/docs/guides/text-generation).

docs/concepts/team/index.md

@@ -4,15 +4,15 @@ hide:
 ---
 # Teams
 
-Open Chat Studio is a [multitenant](https://en.wikipedia.org/wiki/Multitenancy) platform that can support multiple organizations using the same instance at the same time. Each 'tenant' is called a 'team'. Teams are created by an organization and can have multiple members. Each team has its own settings and experiments.
+Open Chat Studio is designed for multiple companies or groups to work securely within the same system while keeping their data completely separate. Technically this is known as a [multitenant](https://en.wikipedia.org/wiki/Multitenancy) platform.
 
-A user can be a member of multiple teams and have a different set of permissions in each team.
+In OCS, these private spaces/tenants are called "Teams". Multiple teams can be setup each with its own members. Each Team has its own settings, private data and chatbots/experiments.
 
-A team serves as the root container for all data in Open Chat Studio.
+As a user, you can belong to several Teams at once with different roles/permissions in each—like being an "Admin" for your support Chatbot but a "Viewer" for the knowledge base team. Roles are managed with [User Groups](groups.md)
 
 ## Team configuration
 
-There is a set of global configuration that can be set at the team level. This includes:
+Global settings are managed at the Team level. This includes:
 
 - [LLM Service Providers](llm_providers.md)
 - Speech Service Providers

docs/concepts/team/llm_providers.md

@@ -1,6 +1,6 @@
 # LLM Service Providers
 
-Building chatbots in Open Chat Studio requires access to [LLMs](../llm.md). This requires providing Open Chat Studio with credentials needed to access the models provided by external services such as OpenAI, Anthropic, and Google.
+Building chatbots in Open Chat Studio requires access to [LLMs](../llm.md). This requires configuring your [Teams](index.md) by providing credentials needed to access the LLM models provided by services such as OpenAI, Anthropic, and Google.
 
 Open Chat Studio currently supports the following providers:
 
@@ -12,6 +12,14 @@ Open Chat Studio currently supports the following providers:
 * Perplexity
 * DeepSeek
 
-## Models
+## LLM Models
 
-Each service provider is pre-configured with the most common models for both AI inference and text embedding. Should the service provider configuration not include a model which is available via the provider, it may be added directly via the user interface. This is done by editing the provider and using the :material-plus-box: button in the 'Custom Models' section.
+Each service provider is pre-configured with the most common models for both AI inference and text embedding. 
+
+Should the service provider configuration not include a model which is available via the provider, it may be added directly via the user interface. This is done by editing the provider and using the :material-plus-box: button in the 'Custom Models' section.
+
+### Adding Custom LLM Models
+
+If your LLM provider list doesn't have a pre-configured model you want to use, you can add it under the "Custom LLM Models" section.
+
+See the [How to guide for adding custom LLM models](../../how-to/configure_providers.md)

docs/how-to/configure_providers.md

@@ -1,6 +1,6 @@
-# Configure Providers
+# Configure LLM Providers
 
-Providers are configured in your team settings under "LLM and Embedding Model Service Providers". Before configuring a provider, ensure that you have an active account at the provider and access to the necessary integration credentials.
+Providers are configured in your [Team](../concepts/team/index.md) settings under "LLM and Embedding Model Service Providers". Before configuring a provider, ensure that you have an active account at the provider and access to the necessary integration credentials.
 
 ## Prerequisites
 
@@ -19,9 +19,17 @@ Providers are configured in your team settings under "LLM and Embedding Model Se
 5. Enter your API key
 6. Save the configuration
 
-## Adding Custom Models
+## Testing Your Configuration
+
+After adding a provider and models, it's recommended to:
+1. Create a test bot
+2. Configure it to use your new provider/model
+3. Send a test message to verify everything works correctly
+
 
-If your provider doesn't have a pre-configured model you want to use, you can add it under the "Custom LLM Models" section.
+## Adding Custom LLM Models
+
+If your LLM provider list doesn't have a pre-configured model you want to use, you can add it under the "Custom LLM Models" section.
 
 ### Model Naming Conventions
 
@@ -50,9 +58,3 @@ For Google (Gemini) models, use the names from the "Model Variant" column. Examp
 
 Find current model names at: https://ai.google.dev/gemini-api/docs/models
 
-## Testing Your Configuration
-
-After adding a provider and models, it's recommended to:
-1. Create a test bot
-2. Configure it to use your new provider/model
-3. Send a test message to verify everything works correctly

docs/how-to/first_chatbot.md

@@ -1,5 +1,9 @@
 # Create your first chatbot
 
-In this video, I walk you through the basic steps to set up your first chatbot in Open Chat Studio. We start by creating an LLM provider, which allows us to connect with services like OpenAI or Anthropic; I chose Anthropic and entered my API key. I then created a chatbot and test it out. After testing the chatbot to ensure it functions correctly, I explain the importance of versioning to maintain user experience while making updates. I encourage you to follow along and create your own chatbot using these steps.
+In this video, I walk you through the basic steps to set up your first [chatbot](../concepts/chatbots/index.md) in Open Chat Studio. We start by creating an [LLM provider](configure_providers.md) for a [Team](../concepts/team/index.md), which allows us to connect with services like OpenAI or Anthropic; I chose Anthropic and entered my API key. I then created a chatbot and test it out. 
+
+After testing the chatbot to ensure it functions correctly, I explain the importance of [versioning](../concepts/versioning.md) to maintain user experience while making updates. 
+
+I encourage you to follow along and create your own chatbot using these steps.
 
 <div style="position: relative; padding-bottom: 56.25%; height: 0;"><iframe src="https://www.loom.com/embed/32924312accf43dd822ed51266a89232?sid=d647d8fc-fe1c-46d5-b3c7-ec4ac56cfd85" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

docs/index.md

@@ -6,27 +6,25 @@ hide:
 
 # Open Chat Studio
 
-This is the home page for all documentation related to [Open Chat Studio](https://github.com/dimagi/open-chat-studio).
+This is the home page for all documentation related to [Open Chat Studio](https://github.com/dimagi/open-chat-studio) (OCS).
 Developed by Dimagi, Open Chat Studio is an easy-to-use, open source platform for rapidly prototyping, testing and
-deploying chatbots created using Large Language Models (LLMs).
+deploying chatbots powered by Large Language Models ([LLMs](concepts/llm.md)).
 
 ## What can I do on Open Chat Studio?
 
-* **Make Your Own Chatbots:** With Open Chat Studio (OCS), you can easily create your own chatbots using advanced
+* **Make Your Own Chatbots:** Easily create your own chatbots using advanced
   language technology. OCS is built for use by program staff and other teams - you don't need to be an engineer to get
   started.
 
-* **Deploy:** Use Open Chat Studio to launch your chatbots on the web and mobile apps such as Telegram and WhatsApp,
-  with more
-  options coming soon.
+* **Deploy:** Launch your chatbots on the web and using mobile [messaging apps](concepts/channels.md/) such as Telegram and WhatsApp
 
 * **Enable Access for All:** Anyone you share a chatbot with will be able to access it, either through a web link or
   directly
-  on platforms such as WhatsApp or Telegram. Chatbot users do not need to have an account on Open Chat Studio to use
+  on messaging platforms such as WhatsApp or Telegram. Chatbot users do not need to have an account on Open Chat Studio to use
   your
   chatbots.
 
-* **View and Download Data:** View and export the data from interactions with your chatbots, formatted In CSV.
+* **View and Download Data:** View and export the data from interactions [(ie Tracing)](concepts/tracing.md) with your chatbots, formatted In CSV.
 
 <div class="grid cards" markdown>
 

mkdocs.yml

@@ -98,15 +98,15 @@ nav:
   - How-to Guides:
       - how-to/index.md
       - how-to/first_chatbot.md
+      - how-to/configure_providers.md
       - how-to/workflow_cookbook.md
       - how-to/add_a_knowledge_base.md
-      - how-to/remote_api.md
+      - how-to/deploy_to_different_channels.md
       - how-to/global_search.md
       - how-to/nl_filter.md
-      - how-to/deploy_to_different_channels.md
-      - how-to/configure_providers.md
-      - how-to/api_access.md
       - how-to/setting_up_a_survey.md
+      - how-to/remote_api.md
+      - how-to/api_access.md
       - how-to/assistants_migration.md
   - Concepts:
       - concepts/index.md