Skip to content

Conversation

@bokelley
Copy link
Contributor

@bokelley bokelley commented Nov 6, 2025

Summary

  • Changes all references to Curation Protocol from "Q2 2025" to "coming soon"
  • Simplifies timeline expectations in documentation
  • Updates 4 files: README.md, github-readme.md, docs/intro.md, and docs/curation/coming-soon.md

Test plan

  • Review documentation changes
  • Verify all Q2 2025 references are updated
  • Ensure consistency across all docs

🤖 Generated with Claude Code

bokelley and others added 7 commits August 26, 2025 21:55
This PR addresses critical gaps in A2A artifact format specification and clarifies the relationship between MCP and A2A response patterns.

## New Documentation Added

### 1. artifacts-and-responses.md
- Unified data model showing MCP and A2A equivalence
- Protocol-specific formatting examples
- Conversational vs direct response patterns
- Task-specific guidance for all AdCP operations
- Clear guidelines for multiple parts vs multiple artifacts

### 2. task-response-patterns.md
- Detailed patterns for each AdCP task type
- Synchronous, asynchronous, and adaptive operation examples
- Progress reporting and error handling patterns
- Real-world examples with complete JSON structures
- Decision framework for response types

### 3. Updated Existing Files
- protocol-mappings.md: Added unified data model section
- a2a.md: Clarified artifacts vs messages distinction
- sidebars.ts: Added new documentation to navigation

## Key Design Decisions

### Consistent Data Structures
- Same JSON schema in MCP `data` field and A2A `data` parts
- Identical validation rules and error codes across protocols
- Protocol-agnostic business logic with transport-specific formatting

### A2A Clarification Pattern
- Clarifications use `message` field (communication)
- Results use `artifacts` field (deliverables)
- Empty `artifacts` array when requesting clarification
- Maintains proper separation of concerns

### Multiple Parts vs Multiple Artifacts
- Multiple parts: Different representations of same content
- Multiple artifacts: Independent, separately consumable results
- Clear guidelines for each AdCP task type

## Benefits

- Eliminates implementation ambiguity for A2A artifacts
- Ensures consistent behavior across MCP and A2A protocols
- Provides concrete examples for all common scenarios
- Establishes clear patterns for conversational interactions
- Enables seamless protocol switching without functionality loss

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
## Major Changes

### Removed Redundant Documentation (~3,500 lines deleted)
- Deleted media-buy/api-reference.md (1,773 lines) - duplicated task docs
- Deleted task-response-patterns.md (494 lines) - examples in task files
- Deleted artifacts-and-responses.md (299 lines) - merged to comparison
- Deleted protocol-mappings.md (310 lines) - merged to comparison
- Deleted response-specification.md (130 lines) - in protocol guides
- Deleted error-specification.md (64 lines) - duplicated error-codes

### Reorganized Protocol Documentation
- Created getting-started.md - Clear entry point for users
- Created mcp-guide.md - Complete consolidated MCP guide
- Created a2a-guide.md - Complete consolidated A2A guide
- Created protocol-comparison.md - Concise comparison (75 lines)
- Simplified context-management.md from 550 to 66 lines

### Improved Reference Section
- Moved authentication to main reference section
- Created data-models.md - Core data structures
- Consolidated error documentation to single location

### Simplified Navigation
Protocols section now has clear user journey:
1. Getting Started (choose protocol)
2. Choose Your Protocol (MCP or A2A guide)
3. Protocol Comparison (if needed)
4. Context Management (if needed)

Reference section now has all specifications in one place.

## Benefits
- Removed ~3,500 lines of redundant documentation
- Clear navigation path for new users
- Single source of truth for each concept
- Easier maintenance with no duplicate updates needed
- Less overwhelming documentation structure

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Fixed links to deleted overview.md → getting-started.md
- Fixed links to deleted api-reference.md → tasks folder
- Fixed links to deleted reference docs in protocol guides
- Fixed placeholder '#' link to point to actual reference
- Ensured all internal links resolve correctly

Build now completes with no errors or warnings.
- Kept new testing.md documentation from main
- Removed api-reference.md as intended in our consolidation
- Resolved sidebars.ts conflict to include testing doc
- A2A handles context automatically at the protocol level
- MCP requires manual context_id management
- Updated all relevant documentation to reflect this key difference
- Removed misleading claims about MCP automatic context handling
- Added npm override to force webpack-dev-server ^5.2.2
- Resolves 18 moderate severity vulnerabilities
- Dev server tested and working correctly
Updates all references to Curation Protocol availability from specific Q2 2025 timeline to generic "coming soon" language across documentation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@bokelley
Copy link
Contributor Author

bokelley commented Nov 6, 2025

Closing this PR - it includes unrelated changes from the bucharest-v2 branch. Will create a new PR from main with only the timeline changes.

@bokelley bokelley closed this Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants