Authoritative project documentation
ApiaryLens Execution Plan
Status
Active portfolio delivery sequence. The Master Architecture and Design Plan remains authoritative for product architecture; this document controls the order in which the portfolio moves from foundation through release.
Progress
- Documentation reconciliation: completed 2026-07-15
- Six-repository GitHub portfolio activation and local cloning: completed 2026-07-15
- Responsibility-specific foundation scaffolds: completed 2026-07-15
- ADR 0003, Apache-2.0 licensing, and the MVP/UAT contract: accepted 2026-07-15
- Cloudflare frontend implementation foundation: next after the documentation change is reviewed and the relevant framework/content research begins
Delivery Rule
ApiaryLens follows a gated sequence:
Foundation -> Discovery and research -> Decisions -> Detailed design ->
Implementation -> Verification -> Deployment and release -> Operate and learn
Work may proceed in parallel when its inputs are stable, but dependent code does not start before the required research, ADRs, security analysis, and contracts are accepted. Documentation is updated with each accepted decision; it is not postponed until after implementation.
Stage 0: Portfolio Foundation
Outcomes:
- Reconcile the master plan, accepted ADRs, supporting designs, roadmap, and tasks.
- Activate and clone
apiarylens,apiarylens-ops,apiarylens.org,apiarylens.app,apiarylens.dev, and.github. - Give every repository a clear responsibility, source-of-truth boundary, agent guidance, contribution/security baseline, and initial directory structure.
- Establish Cloudflare Workers Static Assets as the deployment convention for all official public frontends without selecting an unreviewed frontend framework.
- Create the dedicated Lucid
ApiaryLensfolder and diagram catalog. - Choose the open-source license and accept the open-source/self-hosted ADR.
Exit gate:
- The repository portfolio exists, is locally cloned, has no source-of-truth ambiguity, and passes baseline repository checks.
Stage 1: Discovery and Research
Run time-boxed, evidence-producing spikes for material unknowns:
- Beekeeper workflows, MVP jobs, terminology, accessibility, and outdoor use
- Device-local PWA storage, durability, backup, and migration into synchronization
- Frontend/PWA framework and offline persistence
- Backend framework and API approach
- Database, media storage, and small-footprint deployment
- Synchronization, conflict resolution, and multi-device behavior
- Authentication, authorization, OIDC, recovery, and offline sessions
- Local-network HTTPS and deployment discovery
Scout Beepackaging, privileges, updates, signing, and rollback- Product version source of truth, release manifest, contract compatibility, database and PWA migrations, release promotion, and recovery
- Cloudflare-first family cloud deployment and Compose-on-VM fallback evaluation without changing the portable core
- Public
.org,.app, and.devinformation architecture and Cloudflare build requirements
Exit gate:
- Each spike has dated primary evidence, measured results where applicable, a recommendation, risks, rejected alternatives, and the ADRs it requires.
Stage 2: Architecture Decisions
Accept the minimum durable decisions required for implementation, including:
- License and open-source posture
- Frontend/PWA and offline storage
- Backend, database, migrations, and data access
- Identity, authorization, organization isolation, and sharing
- Synchronization and conflict resolution
- Media storage and processing
- API/OpenAPI and client generation
- Compose, secrets, HTTPS, backups, upgrades, and release integrity
- Product version, build identity, release manifest, channels, API/sync/schema/export compatibility, PWA activation, and supported update/recovery windows
- Cloudflare-native runtime, D1/R2 adapters, quota behavior, backup, export, and migration for the first cloud profile
- Cloudflare frontend framework/build conventions for each public property
Each accepted ADR updates the master architecture and any affected supporting documents in the same change.
Exit gate:
- No implementation-critical decision is merely implied by a task, prototype, or dependency already installed.
Stage 3: Detailed Design and Planning
Produce:
- Lucid system context, trust boundary, component, deployment, data, sync, identity, repository, and delivery-flow diagrams with accessible public exports
- Product requirements and scoped MVP specification
- Domain and data model
- API, synchronization, media, identity, deployment-plan, and connection contracts
- Version, release manifest, artifact promotion, migration, update, rollback, restore, and support-lifecycle contracts
- Threat model, ASVS mapping, privacy analysis, and release-security design
- UX flows and accessible design-system foundation
- Test strategy, acceptance journeys, capacity assumptions, cost model, and rollback plans
- Ordered implementation epics and tasks with explicit dependencies
Exit gate:
- A contributor can implement the first vertical slice without inventing unresolved architecture in code.
Stage 4: Product and Website Implementation
Build in thin, deployable vertical slices:
- PWA shell, local data, accessibility, and offline state
- Core API, database, identity, organizations, apiaries, and hives
- Synchronization across a family deployment
- Inspection and media workflows
- Compose packaging, backup, restore, versioned update, recovery, and diagnostics for owned hardware
- Cloudflare-native family deployment, versioned update and recovery, with Compose-on-VM cloud conformance
- Scout Bee guided deployment and update orchestration
- Cloudflare-hosted
.org,.app, and.devfrontends consuming authoritative content and versioned product artifacts - Safe public demo and measured family-cloud reference profile
Every slice includes tests, security controls, migration behavior, documentation, and deployment support rather than treating them as later cleanup.
Stage 5: Verification, Release, and Operation
- Exercise local, Hyper-V, Cloudflare-style, Azure-style, and provider-neutral test environments without making maintainer infrastructure a product dependency.
- Verify real iPhone, iPad, and desktop PWA journeys, offline recovery, sync, authorization isolation, upgrades, backup/restore, and cost limits.
- Generate SBOMs, signatures, checksums, provenance, release notes, changelog, downloads, and versioned documentation.
- Verify exact build identity, release-manifest traceability, upgrade from a seeded predecessor or supported prior release, PWA pending-work preservation, failed update recovery, and cross-profile compatibility.
- Deploy public frontends through reviewed Cloudflare preview and production gates.
- Publish support boundaries, known limitations, security-fix policy, and operator runbooks.
- Feed production and community learning back into research, ADRs, roadmap, and implementation without bypassing the same governance loop.
Immediate Work Queue
- Finish and validate the documentation reconciliation.
- Verify and maintain the completed Task 008 repository portfolio.
- Complete Task 009: Establish the Cloudflare Frontend Foundation.
- Execute the discovery and research program in dependency order.
- Convert research recommendations into ADRs and detailed designs.
- Produce the implementation-ready task plan with requirement-to-UAT traceability.