Skip to content

docs: add comprehensive READMEs for all service packages and create package overview guide#1137

Merged
xuyushun441-sys merged 3 commits intomainfrom
claude/update-readme-and-fumadocs
Apr 14, 2026
Merged

docs: add comprehensive READMEs for all service packages and create package overview guide#1137
xuyushun441-sys merged 3 commits intomainfrom
claude/update-readme-and-fumadocs

Conversation

@Claude
Copy link
Copy Markdown
Contributor

@Claude Claude AI commented Apr 14, 2026

Scanned codebase and systematically documented all packages with comprehensive READMEs and a central package overview guide in fumadocs.

Service Package READMEs (10 packages)

Created production-ready documentation for all platform services:

  • service-ai - Multi-provider LLM support (OpenAI, Anthropic, Google), conversation management, tool registry, streaming
  • service-analytics - Multi-driver analytics (NativeSQL/ObjectQL/InMemory), aggregations, time series, funnels
  • service-automation - DAG flow execution engine, autolaunched/screen/scheduled flows, visual builder integration
  • service-cache - In-memory and Redis adapters, TTL, namespaces, pattern matching
  • service-feed - Activity streams, comments, @mentions, reactions, field change tracking
  • service-i18n - Multi-language support, interpolation, pluralization, fallback chains
  • service-job - Cron and interval scheduling, retry logic, execution history
  • service-queue - Priority queues with BullMQ/in-memory, worker pools, rate limiting
  • service-realtime - WebSocket pub/sub, presence tracking, collaborative features
  • service-storage - File upload/download with local filesystem and S3, signed URLs, multipart uploads

Driver/Plugin READMEs (3 packages)

  • driver-sql - PostgreSQL, MySQL, SQLite support via Knex.js, migrations, connection pooling
  • plugin-audit - CRUD audit trails, field-level changes, SOC 2/HIPAA/GDPR compliance
  • plugin-mcp-server - Model Context Protocol server, exposes ObjectStack tools/resources/prompts to AI clients (Claude Desktop, Cursor, Cline)

Documentation Site Updates

Created /content/docs/guides/packages.mdx - comprehensive package overview organized by category:

  • Core packages (spec, core, runtime, objectql, metadata, rest)
  • Client packages (client, client-react)
  • Data drivers (memory, sql, turso)
  • Platform services (10 services)
  • Official plugins (8 plugins)
  • Framework adapters (7 adapters)
  • Developer tools (cli, create-objectstack, vscode-objectstack)

Updated main documentation index with package overview card and navigation.

Documentation Standards

Each README follows consistent structure:

  • Features, installation (with mode-specific dependencies), configuration
  • Service API with code examples, advanced features, best practices
  • Performance considerations, contract implementation, troubleshooting
  • Cross-references to related packages and guides

All documentation is production-ready with real-world examples and comprehensive coverage for enterprise use.

Claude AI and others added 3 commits April 14, 2026 07:37
Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/0ea8718e-c180-4863-8bbb-e522375ff695

Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
…on index

Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/0ea8718e-c180-4863-8bbb-e522375ff695

Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
objectstack-demo Ready Ready Preview, Comment Apr 14, 2026 7:48am
objectstack-play Ready Ready Preview, Comment Apr 14, 2026 7:48am
spec Ready Ready Preview, Comment Apr 14, 2026 7:48am

Request Review

@xuyushun441-sys xuyushun441-sys marked this pull request as ready for review April 14, 2026 07:48
@github-actions github-actions bot added documentation Improvements or additions to documentation size/xl labels Apr 14, 2026
@xuyushun441-sys xuyushun441-sys merged commit bd7c47e into main Apr 14, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/xl

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants