Skip to content

feat(chatdev): migrate Chatdev cookbook from archive - #81

Closed
atao2004 wants to merge 1 commit into
mainfrom
cookbook-chatdev-revamp
Closed

atao2004 wants to merge 1 commit into
mainfrom
cookbook-chatdev-revamp

Conversation

@atao2004

@atao2004 atao2004 commented Aug 7, 2026 •

Copy link
Copy Markdown

Summary

Migrates the ChatDev + Valkey cookbook from archive/main-pre-reorg to the current CONTRIBUTING.md structure.

What was migrated

The upstream PR is open and stale. The cookbook documents its proposed API but does not import ChatDev because the upstream project is not published as an installable package.

Changes from the original

  • Preserved and expanded the three cookbook guides with current lead, audience, prerequisite, Step, security, configuration, and navigation requirements.
  • Added a standalone runnable sample that reproduces the verified Valkey behavior without importing ChatDev.
  • Added deterministic no-key embeddings as the default, with optional OpenAI and Ollama providers.
  • Added exact dependency pins:
    • valkey-glide-sync==2.5.0
    • pytest==8.3.5
  • Added docker-compose.yml, .env.example, .gitignore, tests, and expected-output documentation.
  • Corrected the original :latest image references and internal-looking hostname.
  • Added GLIDE credentials/database forwarding and aligned the sample with the verified upstream defaults.
  • Removed obsolete meta.json rendering metadata.
  • Added temporary .github/workflows/cookbook-python.yml for framework-integrations/chatdev.
  • The CI workflow tests Valkey Bundle 9.1.0 only because the required Search TEXT schema is unavailable in the relevant 8.x Search module.

Validation

Check Result
Markdown lint PASS — 0 issues
Syntax/type check PASS — all four Python files compile
Dependency install (cold cache) PASS — exact pinned requirements installed
Valkey container + PING PASS — Finch with valkey/valkey-bundle:9.1.0
Sample run PASS — quick_start.py assertions passed
Tests PASS — 18 tests passed

Cookbook structure

cookbooks/framework-integrations/chatdev/
├── README.md
├── 01-getting-started.md
├── 02-vector-memory.md
├── 03-production.md
└── sample/
    ├── README.md
    ├── .env.example
    ├── .gitignore
    ├── docker-compose.yml
    ├── embeddings.py
    ├── quick_start.py
    ├── requirements.txt
    ├── test_valkey_memory.py
    └── valkey_memory.py

Vendor neutrality statement

The default path uses a deterministic local embedding provider and requires no paid service or cloud account. OpenAI and Ollama are documented as optional alternatives. ChatDev affiliation is disclosed as an OpenBMB open-source project.

Version compatibility notes

  • Valkey image: valkey/valkey-bundle:9.1.0
  • Required Search module support: Valkey Search 1.2.0 or later for the TEXT field and query behavior used here.
  • Python: 3.11 in CI.
  • Dependencies are exact-pinned.
  • Upstream ChatDev PR #634 remains open and unmerged.
  • This sample independently reproduces the upstream Valkey commands, key pattern, schema, TTL behavior, and KNN retrieval behavior.

Relationship to other PRs

Pre-Submit Checklist

  • Builds and runs from a clean clone
  • Runs against current stable Valkey (or Valkey Bundle)
  • No private links, internal references, or local paths
  • No marketing language or uncited claims
  • Vendor-neutral by default (affiliation disclosed where applicable)
  • README explains the Valkey concept demonstrated, prerequisites, and how to run
  • Dependencies pinned to specific versions
  • CI validates the sample

- Migrate the three ChatDev + Valkey guides and standalone runnable sample into the current cookbook structure
- Use a local deterministic embedding default, document optional providers, and record the open upstream ChatDev #634 status
- Pin valkey-glide-sync==2.5.0 and pytest==8.3.5, and add temporary Python cookbook CI for Valkey Bundle 9.1.0

Signed-off-by: Anna Tao <annatao2004@gmail.com>
@atao2004 atao2004 changed the title feat(chatdev): migrate chatdev cookbook from archive feat(chatdev): migrate Chatdev cookbook from archive Aug 7, 2026
@jbrinkman jbrinkman added the Cookbook Cookbooks are tutorials with runnable code that highlights how to use Valkey in specific scenarios label Aug 12, 2026
@jbrinkman

Copy link
Copy Markdown
Collaborator

Closing this draft PR as part of a cookbook program cleanup.

@jbrinkman jbrinkman closed this Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Cookbook Cookbooks are tutorials with runnable code that highlights how to use Valkey in specific scenarios

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants