{"id":35233940,"url":"https://github.com/dimagi/open-chat-studio-docs","last_synced_at":"2026-02-23T16:00:57.845Z","repository":{"id":263605190,"uuid":"890911656","full_name":"dimagi/open-chat-studio-docs","owner":"dimagi","description":"User documentation for Open Chat Studio","archived":false,"fork":false,"pushed_at":"2026-02-19T10:35:44.000Z","size":4120,"stargazers_count":4,"open_issues_count":3,"forks_count":3,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-02-19T15:11:59.510Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dimagi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-19T11:56:54.000Z","updated_at":"2026-02-19T10:35:28.000Z","dependencies_parsed_at":"2024-12-13T10:34:10.076Z","dependency_job_id":"7e585846-403b-45d0-8175-94932c1afd80","html_url":"https://github.com/dimagi/open-chat-studio-docs","commit_stats":null,"previous_names":["dimagi/open-chat-studio-docs"],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/dimagi/open-chat-studio-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fopen-chat-studio-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fopen-chat-studio-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fopen-chat-studio-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fopen-chat-studio-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dimagi","download_url":"https://codeload.github.com/dimagi/open-chat-studio-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dimagi%2Fopen-chat-studio-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29747979,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-23T07:44:07.782Z","status":"ssl_error","status_checked_at":"2026-02-23T07:44:07.432Z","response_time":90,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-30T03:25:33.500Z","updated_at":"2026-02-23T16:00:57.837Z","avatar_url":"https://github.com/dimagi.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![](docs/assets/logo.png)](https://github.com/dimagi/open-chat-studio)\n\nThis repository contains the user documentation for [Open Chat Studio](https://github.com/dimagi/open-chat-studio).\n\nOpen Chat Studio is a platform for building, deploying, and evaluating AI-powered chat applications. It provides tools for working with various LLMs (Large Language Models), creating chatbots, managing conversations, and integrating with different messaging platforms.\n\n## Docs Quickstart\n\nAssuming you've already cloned this repository:\n\n1. Install UV\n\n    ```shell\n    curl -LsSf https://astral.sh/uv/install.sh | sh\n    ```\n    \n    See https://docs.astral.sh/uv/getting-started/installation/\n\n2. Set up the project\n    \n    ```shell\n    uv venv\n    uv sync\n    ```\n\n3. Start the project\n    \n    ```shell\n    uv run mkdocs serve\n    ```\n\n### Writing\n\nSee the [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/) for how to write documentation.\n\n\n### API docs\n\nAPI docs are generated automatically based on the OpenAPI schema. This is done using the `src/ocs_docs/openapi_to_docs.py` utility.\n\n```bash\npython src/ocs_docs/openapi_to_docs.py https://openchatstudio.com/api/schema -o docs/api\n```\n\nThis utility is used in the `update-api-docs` GitHub action.\n\n## Chat Widget Docs\n\nDocumentation for the embeddable chat widget lives under `docs/chat_widget/` and ships on a different cadence from the rest of Open Chat Studio. To keep those docs aligned with widget releases:\n\n- Start branches from `widget-develop`, and open the pull request against `widget-develop` so updates can be bundled into the next widget release.\n- Limit changes to the widget docs (and their assets) when targeting `widget-develop`; broader documentation updates should continue to go to `main`.\n- Release managers merge `widget-develop` back into `main` as part of the widget release process, so no extra action is needed once the PR is approved.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimagi%2Fopen-chat-studio-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdimagi%2Fopen-chat-studio-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdimagi%2Fopen-chat-studio-docs/lists"}