From f986bca5b13e778bc31433656259fce8486b3895 Mon Sep 17 00:00:00 2001 From: Brian O'Kelley Date: Wed, 30 Jul 2025 16:17:42 +0200 Subject: [PATCH] docs: improve documentation framework and remove certification references MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Remove certification.md and all certification references (not ready yet) - Fix broken links in README.md - Simplify working-group.md to focus on GitHub Discussions - Align repository structure in README with actual structure - Add reference implementations section to README These changes make the docs more accurate and easier to navigate for users. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 24 +-- docs/community/working-group.md | 101 +++-------- docs/reference/certification.md | 302 -------------------------------- 3 files changed, 33 insertions(+), 394 deletions(-) delete mode 100644 docs/reference/certification.md diff --git a/README.md b/README.md index ddb48372b9..62d098e152 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,9 @@ Execute and optimize media buys programmatically across platforms. Implement AdCP to enable AI-powered workflows for your customers: -1. **Review the Specification**: [Audience Protocol RFC](./audience-protocol-v1.md) -2. **Implement MCP Server**: Follow the [implementation guide](https://adcontextprotocol.github.io/docs/implementation/getting-started) +1. **Review the Specification**: [Audience Protocol](https://adcontextprotocol.github.io/docs/audience/specification) +2. **Implement MCP Server**: Check out the [reference implementations](#reference-implementations) 3. **Test Your Implementation**: Use the validation test suite -4. **Get Certified**: Ensure your implementation meets quality standards. ### For Advertisers & Agencies @@ -62,10 +61,10 @@ Use AdCP-enabled platforms with your AI assistant: adcontextprotocol/ ├── docs/ # Documentation source files │ ├── audience/ # Audience protocol docs -│ ├── implementation/ # Implementation guides +│ ├── curation/ # Curation protocol (coming soon) +│ ├── media-buy/ # Media Buy protocol docs │ └── reference/ # API reference ├── src/ # Website source files -├── audience-protocol-v1.md # Protocol specification └── README.md # This file ``` @@ -90,6 +89,11 @@ We welcome contributions from: See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines. +## Reference Implementations + +- [Audience Agent](https://github.com/adcontextprotocol/audience-agent) +- [Sales Agent](https://github.com/adcontextprotocol/salesagent) + ## Platform Implementations ### Current Support @@ -98,16 +102,6 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines. - **Scope3**: Full Audience Activation Protocol support - **More Coming**: Additional platforms implementing Q1 2025 -### Certification - -Platform implementations can be certified for compliance and quality: - -1. **Technical Compliance**: Pass validation test suite -2. **Performance Standards**: Meet response time requirements -3. **Security Review**: Complete security assessment -4. **Documentation**: Provide complete integration docs - -Learn more: [Certification Process](https://adcontextprotocol.github.io/docs/reference/certification) ## Documentation Website diff --git a/docs/community/working-group.md b/docs/community/working-group.md index de52547a5a..664f06a523 100644 --- a/docs/community/working-group.md +++ b/docs/community/working-group.md @@ -3,93 +3,40 @@ sidebar_position: 1 title: Working Group --- -# Ad Context Protocol Working Group +# AdCP Working Group -Join our working group to help shape the future of advertising technology standards. +The Ad Context Protocol Working Group is an open community of platform providers, advertisers, agencies, and developers working together to shape the future of AI-powered advertising. -## About the Working Group +## Join the Discussion -The ACP Working Group brings together industry leaders, platform providers, agencies, and advertisers to collaboratively develop and evolve the Ad Context Protocol standards. +Our primary collaboration happens through GitHub Discussions: -## How to Participate - -### Monthly Meetings -- **When**: First Wednesday of each month, 2:00 PM EST -- **Where**: Virtual meeting (Zoom link provided to members) -- **Format**: Open discussion, specification reviews, and roadmap planning - -### GitHub Discussions -Join ongoing conversations and propose new ideas: -- [Protocol Discussions](https://github.com/adcontextprotocol/adcp/discussions) -- [Implementation Questions](https://github.com/adcontextprotocol/adcp/discussions/categories/q-a) -- [Feature Requests](https://github.com/adcontextprotocol/adcp/discussions/categories/ideas) - -## Current Focus Areas - -### Q1 2025 Priorities -- **Audience Protocol Refinements**: Based on early implementation feedback -- **Curation Protocol Design**: Initial specification development -- **Platform Onboarding**: Supporting new platform implementations - -### Working Groups -- **Technical Standards**: Protocol specifications and validation -- **Implementation Support**: Platform integration guidance -- **Industry Adoption**: Outreach and education initiatives - -## Membership +**[→ Join the AdCP Community on GitHub Discussions](https://github.com/adcontextprotocol/adcp/discussions)** -### Who Should Join -- **Platform Providers**: DSPs, data providers, ad tech companies -- **Agencies & Advertisers**: Users of advertising technology -- **Developers**: Engineers implementing ACP -- **Industry Experts**: Standards bodies, consultants, researchers +## What We Discuss -### Benefits -- Early access to new protocol specifications -- Direct input on standard development -- Networking with industry leaders -- Implementation support and guidance +- **Protocol Development**: Propose and discuss new features and improvements +- **Implementation Questions**: Get help implementing AdCP in your platform +- **Use Cases**: Share how you're using AdCP in real-world scenarios +- **Best Practices**: Learn from others' experiences and share your own +- **Future Direction**: Help shape the roadmap for AdCP -## Get Involved - -### Join the Working Group -1. **Subscribe**: Email announcements@adcontextprotocol.org -2. **Introduce Yourself**: Post in [GitHub Discussions](https://github.com/adcontextprotocol/adcp/discussions) -3. **Attend Meetings**: RSVP for monthly working group calls - -### Contributing -- **Specification Reviews**: Help review and improve protocol specs -- **Implementation Feedback**: Share experiences from real-world usage -- **Documentation**: Contribute examples, guides, and best practices -- **Testing**: Participate in interoperability testing - -## Leadership - -### Steering Committee -The working group is guided by a steering committee with representatives from: -- Platform providers -- Large advertisers/agencies -- Technical standards organizations -- Open source contributors - -### Current Initiatives -- **Interoperability Testing**: Cross-platform compatibility validation -- **Performance Benchmarks**: Standard performance metrics and testing -- **Security Guidelines**: Best practices for secure implementations +## How to Participate -## Resources +1. **Start a Discussion**: Share ideas, ask questions, or propose changes +2. **Join Conversations**: Comment on existing discussions +3. **Share Experiences**: Tell us about your implementation journey +4. **Help Others**: Answer questions and share your expertise -### For New Members -- [Getting Started Guide](../intro) +## Stay Updated -### Meeting Materials -- [Meeting Archives](https://github.com/adcontextprotocol/adcp/discussions/categories/meetings) -- [Specification Drafts](https://github.com/adcontextprotocol/adcp/tree/main/specs) +- **Watch the Repository**: Get notifications about new discussions +- **Star the Project**: Show your support and stay connected +- **Follow Announcements**: Important updates are posted in the Announcements category -## Contact +## Other Ways to Connect -- **General Questions**: working-group@adcontextprotocol.org -- **Technical Issues**: support@adcontextprotocol.org -- **Partnership Inquiries**: partnerships@adcontextprotocol.org +- **Email**: For private inquiries, reach out to hello@adcontextprotocol.org +- **GitHub Issues**: Report bugs or request features in the [issue tracker](https://github.com/adcontextprotocol/adcp/issues) -Ready to help shape the future of advertising technology? Join us! \ No newline at end of file +We look forward to collaborating with you! \ No newline at end of file diff --git a/docs/reference/certification.md b/docs/reference/certification.md deleted file mode 100644 index f2cbdead45..0000000000 --- a/docs/reference/certification.md +++ /dev/null @@ -1,302 +0,0 @@ ---- -sidebar_position: 5 -title: Certification ---- - -# ACP Platform Certification - -Official certification program for Ad Context Protocol implementations. - -## Certification Overview - -The ACP Certification Program ensures that platform implementations meet quality, performance, and security standards for reliable industry adoption. - -### Benefits of Certification - -**For Platform Providers**: -- Official ACP compliance badge and listing -- Marketing and promotion support -- Technical validation and credibility -- Access to certification-only resources - -**For Users**: -- Confidence in implementation quality -- Guaranteed interoperability -- Performance and reliability assurance -- Consistent user experience across platforms - -## Certification Levels - -### Bronze Certification - Basic Compliance - -**Requirements**: -- Implement all required protocol endpoints -- Pass automated validation test suite -- Meet minimum performance benchmarks -- Provide basic documentation - -**Test Coverage**: -- Core functionality validation -- Error handling verification -- Basic performance testing -- Security baseline checks - -### Silver Certification - Production Ready - -**Additional Requirements**: -- Advanced performance benchmarks -- Security assessment completion -- Load testing validation -- Comprehensive documentation -- Customer reference implementations - -**Test Coverage**: -- Stress testing under load -- Security penetration testing -- Integration with multiple client types -- Edge case handling validation - -### Gold Certification - Industry Leader - -**Additional Requirements**: -- Innovation features implementation -- Community contribution requirements -- Advanced security certifications -- Uptime and reliability guarantees -- 24/7 support availability - -**Test Coverage**: -- Comprehensive feature coverage -- Advanced security audit -- Multi-region deployment testing -- Disaster recovery validation - -## Certification Process - -### Phase 1: Application Submission - -**Required Materials**: -1. **Technical Documentation** - - Complete API documentation - - Implementation architecture overview - - Security and privacy policies - - Performance characteristics - -2. **Self-Assessment** - - Completed certification checklist - - Test results from validation suite - - Security self-assessment report - -3. **Implementation Access** - - Test credentials for certification team - - Access to staging/testing environment - - Documentation for testing procedures - -### Phase 2: Technical Validation - -**Automated Testing** (1-2 weeks): -- Protocol compliance validation -- Performance benchmark testing -- Security baseline scanning -- Integration testing with reference clients - -**Manual Review** (2-3 weeks): -- Code quality assessment -- Security architecture review -- Documentation completeness check -- User experience evaluation - -### Phase 3: Security Assessment - -**Security Requirements**: -- Vulnerability assessment -- Authentication mechanism review -- Data protection verification -- Incident response procedures - -**Security Testing**: -- Penetration testing (Silver/Gold only) -- Threat modeling review -- Compliance validation (GDPR, CCPA, etc.) -- Access control verification - -### Phase 4: Performance Validation - -**Performance Metrics**: -``` -Bronze Level: -- Response time: < 2 seconds (95th percentile) -- Throughput: 100 requests/minute minimum -- Uptime: 99% monthly availability - -Silver Level: -- Response time: < 1 second (95th percentile) -- Throughput: 500 requests/minute minimum -- Uptime: 99.5% monthly availability - -Gold Level: -- Response time: < 500ms (95th percentile) -- Throughput: 1000+ requests/minute -- Uptime: 99.9% monthly availability -``` - -**Load Testing**: -- Sustained load testing (24+ hours) -- Peak load handling capability -- Graceful degradation under stress -- Recovery time after outages - -### Phase 5: Final Review - -**Certification Committee Review**: -- Technical implementation assessment -- Security posture evaluation -- Documentation quality review -- Overall user experience rating - -**Decision Criteria**: -- All automated tests passing -- Security requirements met -- Performance benchmarks achieved -- Documentation standards satisfied - -## Certification Maintenance - -### Annual Recertification - -**Requirements**: -- Updated test suite execution -- Security reassessment -- Performance validation -- Documentation updates - -**Process**: -- Streamlined testing for existing certified platforms -- Focus on new features and protocol updates -- Validation of continued compliance -- Review of any reported issues - -### Continuous Monitoring - -**Ongoing Requirements**: -- Incident reporting within 48 hours -- Quarterly performance reporting -- Annual security assessments -- Participation in interoperability testing - -**Monitoring Metrics**: -- Service availability and performance -- User satisfaction feedback -- Security incident tracking -- Protocol compliance drift - -## Certification Testing - -### Validation Test Suite - -**Installation**: -```bash -npm install -g @adcontextprotocol/certification-suite -``` - -**Basic Testing**: -```bash -# Run full certification test suite -acp-certify --endpoint https://api.yourplatform.com \ - --credentials ./test-credentials.json \ - --level bronze - -# Run specific test categories -acp-certify --tests security,performance \ - --endpoint https://api.yourplatform.com -``` - -**Test Categories**: -- **Protocol Compliance**: All endpoints and response formats -- **Error Handling**: Proper error responses and codes -- **Security**: Authentication, authorization, input validation -- **Performance**: Response times, throughput, reliability -- **Integration**: Cross-platform compatibility testing - -### Custom Testing - -**Platform-Specific Tests**: -Platforms may need additional testing for: -- Unique features beyond standard protocol -- Integration with existing platform capabilities -- Custom authentication mechanisms -- Specialized audience types or data sources - -## Certification Costs - -### Pricing Structure - -**Bronze Certification**: -- Application fee: $5,000 -- Annual maintenance: $2,500 -- Re-certification: $2,500 - -**Silver Certification**: -- Application fee: $15,000 -- Annual maintenance: $7,500 -- Re-certification: $5,000 - -**Gold Certification**: -- Application fee: $30,000 -- Annual maintenance: $15,000 -- Re-certification: $10,000 - -**Enterprise Packages**: -- Multi-platform discounts available -- Custom certification tracks for large implementations -- Dedicated certification manager assignment - -### Payment Terms - -- 50% due upon application acceptance -- 50% due upon successful certification -- Annual maintenance fees due yearly from certification date -- Re-certification fees due upon renewal - -## Application Process - -### Getting Started - -1. **Review Requirements**: Ensure your implementation meets minimum standards -2. **Complete Self-Assessment**: Use the certification checklist -3. **Prepare Documentation**: Gather all required materials -4. **Submit Application**: Online application with required materials -5. **Schedule Kickoff**: Initial meeting with certification team - -### Timeline - -**Typical Certification Timeline**: -- Application review: 1 week -- Technical validation: 2-4 weeks -- Security assessment: 1-3 weeks -- Performance testing: 1-2 weeks -- Final review: 1 week -- **Total**: 6-11 weeks depending on level - -### Contact Information - -**Certification Team**: certification@adcontextprotocol.org - -**Application Portal**: [https://certification.adcontextprotocol.org](https://certification.adcontextprotocol.org) - -**Support**: For technical questions during certification process - -## Certified Platforms - -### Current Certified Platforms - - - -### Certification Status Verification - -Verify a platform's certification status: -- **Badge Verification**: Look for official ACP certification badges -- **Platform Directory**: Check the certified platforms list -- **API Verification**: Query certification status API - -Ready to get certified? Start your application today! 🏆 \ No newline at end of file