Skip to content

READMEs are out of sync with current code (packages, API count, persistence sections, agent workbench support) #1332

Description

@CXuPercy

Problem

The READMEs (EN + ZH) lag behind the current codebase:

  • README-zh.md is missing the server-backed persistence (PostgreSQL) and MP4 video export (render-service) sections that README.md already has
  • The project-structure tree lists only 2 workspace packages, but packages/@openmaic/ now contains 6 SDK packages (dsl, generation, renderer, importer, editor, storage), and render-service/ exists
  • API endpoint count is stale ("~18" vs actual 26)
  • The OpenMAIC skill now works beyond OpenClaw (Codex, DeepSeek, WorkBuddy and other agent workbenches), but the READMEs only mention OpenClaw
  • The intro videos should be updated to the v1.0 versions

Proposal

Sync both READMEs with the current code, document multi-workbench skill support, and swap in the v1.0 videos.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions