0.3.0 • Published 11 months ago

@meldscience/collab-spec v0.3.0

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

Collab Spec

Core types and adapters for building collaborative AI modules.

For Module Developers

This package provides:

  • Type definitions for building collaborative AI modules
  • Adapters for external SDK compatibility
  • Comprehensive documentation for module development

Getting Started

  1. Install the package:
npm install @collab-spec
  1. Read src/docs/init/SETUP.md for instructions on setting up your development environment, including how to link the spec documentation into your module.

Documentation

The src/docs directory contains comprehensive documentation for module developers:

  • init/SETUP.md: Initial setup and documentation structure
  • TYPES.md: Type system guide and SDK adapter usage
  • PATTERNS.md: Common patterns and best practices for module development

We recommend symlinking these docs into your module's documentation directory - see init/SETUP.md for details.

Contributing

See docs/CONTRIBUTING.md for information about contributing to the spec.