Skip to content

Commit c8b0487

Browse files
committed
feat: complete Phase 1 EAP documentation
Completed comprehensive Early Access Program documentation to support 5 EAP participants launching in 1-2 weeks targeting 2026.1 GA release. Phase 1 EAP Documentation (6 new files): - docs/EAP_GUIDE.md: Complete program guide (timeline, expectations, feedback channels, participant activities) - docs/EAP_KNOWN_ISSUES.md: Known limitations and bugs with workarounds (11 limitations, 8 bugs, organized by category) - docs/EAP_ROADMAP.md: Feature evolution from EAP → GA → Post-GA with committed GA features and future considerations - docs/EAP_FAQ.md: 40+ frequently asked questions covering program, technical, feedback, and timeline topics - docs/INSTALLATION.md: Platform-specific installation (macOS primary, Linux/Windows secondary) with Docker and local methods - docs/TROUBLESHOOTING.md: Comprehensive troubleshooting guide with diagnostic information collection Repository Updates: - README.md: Added EAP badge, welcome section, feedback channels, prioritized EAP documentation section Feature Specification: - specs/003-enhance-documentation-in/: Complete spec with 6 user stories, 26 functional requirements, decisions summary, assessment Documentation Summary: - 6 new comprehensive docs (~25,000 words total) - Organized by EAP phase (Phase 1: Pre-EAP critical docs) - Target: <30 min installation, <1 support request per participant - Success gate: Can onboard EAP participant with docs only Feedback Channels Documented: - Survey: Data Platforms Product Team (primary) - Email: thomas.dyar@intersystems.com (1-2 business day response) - GitHub Issues: Optional technical feedback (under exploration) Known Issues Sources: - Repository analysis - Confluence "Pluggable Models Test Plan" - JIRA tickets (DP-434440, DP-434441, related bugs) Per specs/003-enhance-documentation-in/spec.md: - User Story 1: EAP Participant Onboarding (P1) - Complete - User Story 2: Installation & Prerequisites (P1) - Complete - FR-001 through FR-009: All Phase 1 requirements met - SC-001 through SC-007: Ready for validation with EAP participants Ready for EAP launch in 1-2 weeks.
1 parent 5372219 commit c8b0487

File tree

12 files changed

+6759
-1
lines changed

12 files changed

+6759
-1
lines changed

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,32 @@
55
[![IRIS 2025.2](https://img.shields.io/badge/IRIS-2025.2-blue.svg)](https://www.intersystems.com)
66
[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org)
77
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
8+
[![EAP Status](https://img.shields.io/badge/status-Early%20Access%20Program-orange.svg)](docs/EAP_GUIDE.md)
9+
10+
---
11+
12+
## 🚀 Early Access Program (EAP)
13+
14+
**Welcome EAP Participants!** You're among a select group of 5 participants helping shape this feature before the IRIS 2026.1 GA release.
15+
16+
### Getting Started with EAP
17+
1. **[Read the EAP Guide](docs/EAP_GUIDE.md)** - Understand the program, timeline, and expectations
18+
2. **[Install Custom Models](docs/INSTALLATION.md)** - Complete installation in <30 minutes (target)
19+
3. **[Check Known Issues](docs/EAP_KNOWN_ISSUES.md)** - Review current limitations before reporting bugs
20+
4. **[Review Roadmap](docs/EAP_ROADMAP.md)** - See what's coming from EAP to GA
21+
22+
### How to Provide Feedback
23+
Your feedback directly shapes the final product! Choose your preferred channel:
24+
25+
- **Survey** (recommended): Survey links provided by Data Platforms Product Team
26+
- **Email**: [thomas.dyar@intersystems.com](mailto:thomas.dyar@intersystems.com)
27+
- **GitHub Issues** (if enabled): Technical bugs and feature requests
28+
29+
**Response time**: 1-2 business days during EAP
30+
31+
For questions or support, see [EAP FAQ](docs/EAP_FAQ.md) or email thomas.dyar@intersystems.com.
32+
33+
---
834

935
## Table of Contents
1036

@@ -127,13 +153,22 @@ make demo-dna
127153

128154
This project's documentation is organized into three main areas:
129155

156+
### 🔶 EAP Documentation (Start Here!)
157+
Essential guides for Early Access Program participants:
158+
- **[EAP Guide](docs/EAP_GUIDE.md)** - Program overview, timeline, feedback channels
159+
- **[Installation Guide](docs/INSTALLATION.md)** - Platform-specific setup (macOS primary, Linux/Windows secondary)
160+
- **[Known Issues](docs/EAP_KNOWN_ISSUES.md)** - Current limitations and workarounds
161+
- **[EAP Roadmap](docs/EAP_ROADMAP.md)** - Features from EAP to GA (2026.1)
162+
- **[EAP FAQ](docs/EAP_FAQ.md)** - Frequently asked questions
163+
- **[Troubleshooting](docs/TROUBLESHOOTING.md)** - Common issues and solutions
164+
130165
### 📚 Core Documentation ([`docs/`](docs/))
131166
Cross-cutting technical documentation for the entire project:
132167
- **[Quick Start Guide](docs/QUICK_GUIDE_CUSTOM_MODELS.md)** - Get started in under 5 minutes
168+
- **[User Guide](docs/user_guide.md)** - Step-by-step usage instructions
133169
- **[Architecture](docs/architecture.md)** - System design, base class hierarchy, integration patterns
134170
- **[API Reference](docs/api_reference.md)** - Complete API documentation for all model classes
135171
- **[Deployment](docs/deployment.md)** - Production deployment strategies and configuration
136-
- **[User Guide](docs/user_guide.md)** - Step-by-step usage instructions
137172

138173
### 🎯 Demo Applications ([`demos/`](demos/))
139174
Working examples with demo-specific setup instructions:

0 commit comments

Comments
 (0)