Add comprehensive protocol documentation for 70 spec definitions

[Copilot]

The repository lacked discoverable documentation for its 70 protocol specifications across 11 modules. Users had no quick way to navigate or understand the complete protocol inventory.

Changes

New Documentation Structure (English only)

• PROTOCOL_INDEX.md - Direct navigation to all 70 protocols with source links
• PROTOCOL_REFERENCE.md - Complete inventory with descriptions, usage patterns, and naming conventions
• PROTOCOL_ORGANIZATION.md - Visual diagrams showing module hierarchy, layer architecture, and dependencies

Updated Files

• README.md - Added protocol reference section with module breakdown statistics

Protocol Coverage

Data Protocol:       8 protocols  (field, object, query, validation, filter, dataset, mapping, hook)
UI Protocol:        10 protocols  (view, page, app, dashboard, report, action, component, block, theme, widget)
System Protocol:    14 protocols  (manifest, datasource, driver, plugin, context, events, job, audit, logger, translation, feature, scoped-storage)
AI Protocol:         8 protocols  (agent, model-registry, rag-pipeline, nlq, conversation, cost, predictive, orchestration)
API Protocol:        6 protocols  (contract, endpoint, router, odata, realtime, discovery)
Automation:          7 protocols  (flow, workflow, approval, webhook, etl, sync, connector)
Auth:                6 protocols  (identity, role, organization, policy, config, scim)
Permission:          4 protocols  (permission, sharing, rls, territory)
Hub:                 5 protocols  (marketplace, composer, license, tenant, space)
Shared:              1 protocol   (identifiers)
Stack:               1 protocol   (stack)

Navigation Example

// Quick lookup in PROTOCOL_INDEX.md → src/data/field.zod.ts
import { FieldSchema } from '@objectstack/spec/data';

// Detailed reference in PROTOCOL_REFERENCE.md
// Visual structure in PROTOCOL_ORGANIZATION.md

All documentation is cross-referenced and provided in English. Build generates 473 MDX API reference files in content/docs/references/.

Original prompt

扫描目前所有的spec协议，更新文档

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[vercel]

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

Project	Deployment	Review	Updated (UTC)
spec	Ready	Preview, Comment	Jan 27, 2026 8:14am

[hotlong]

@copilot 所有文档使用英文

[Copilot]

@copilot 所有文档使用英文

Done! Removed Chinese documentation file (PROTOCOL_UPDATE_SUMMARY_ZH.md). All documentation is now English-only. (commit ca7b4a9)

[Copilot]

Pull request overview

This PR adds comprehensive documentation for the ObjectStack protocol specifications, addressing the lack of discoverable documentation for the repository's 70 protocol definitions across 11 modules.

Changes:

• Added three new documentation files (PROTOCOL_INDEX.md, PROTOCOL_REFERENCE.md, PROTOCOL_ORGANIZATION.md) providing quick navigation, complete inventory, and visual organization of all protocols
• Updated README.md with a new "Protocol Reference" section linking to the new documentation and updated module descriptions to reflect accurate protocol counts

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
README.md	Added protocol reference section with links to new documentation files; updated protocol architecture section with accurate counts (70 protocols across 11 modules) and detailed module breakdowns
PROTOCOL_REFERENCE.md	New comprehensive reference document with detailed protocol inventory, usage examples, naming conventions, design principles, and version history for all 70 protocols organized by module
PROTOCOL_ORGANIZATION.md	New visual documentation with ASCII diagrams showing file structure, protocol layers, dependencies, and navigation guides across the 11 protocol modules
PROTOCOL_INDEX.md	New quick-reference index with direct links to all 70 protocol source files, organized by module with descriptions and usage instructions

[Copilot]

Version number inconsistency detected. This file states "Protocol Version: 0.3.3" but PROTOCOL_REFERENCE.md indicates that as of 2026-01-27 (today), the version should be "0.4.x" with 70 protocols. Please update this to "0.4.x" to match the version history documented in PROTOCOL_REFERENCE.md.