docs(ecosystem): track phase1 contract baseline
This commit is contained in:
parent
76f1b47484
commit
dd3d622e24
@ -1,6 +1,6 @@
|
||||
# Ecosystem Event Taxonomy
|
||||
|
||||
> **Status:** Draft
|
||||
> **Status:** Phase 1 baseline implemented
|
||||
> **Owner:** `learning_ai_common_plat`
|
||||
> **Purpose:** Define the canonical event vocabulary for cross-product activity, agent execution, approvals, artifacts, and downstream replay.
|
||||
|
||||
@ -186,10 +186,10 @@ Rules:
|
||||
|
||||
These should be implemented first because they unlock the initial cross-product flows:
|
||||
|
||||
- [ ] `capture.transcript.created`
|
||||
- [ ] `artifact.created`
|
||||
- [ ] `artifact.linked`
|
||||
- [ ] `memory.entry.created`
|
||||
- [x] `capture.transcript.created`
|
||||
- [x] `artifact.created`
|
||||
- [x] `artifact.linked`
|
||||
- [x] `memory.entry.created`
|
||||
- [ ] `plan.created`
|
||||
- [ ] `plan.routine.generated`
|
||||
- [ ] `plan.habit.generated`
|
||||
@ -202,6 +202,7 @@ These should be implemented first because they unlock the initial cross-product
|
||||
Commits:
|
||||
|
||||
- `41fa2cd` drafted the event taxonomy
|
||||
- `76f1b47` added canonical Phase 1 event schemas and example payloads
|
||||
|
||||
---
|
||||
|
||||
@ -280,13 +281,19 @@ Consumers such as ActionTrail, timeline services, approval engines, and analytic
|
||||
|
||||
## 12. Implementation Checklist
|
||||
|
||||
- [ ] finalize the canonical envelope
|
||||
- [ ] finalize the phase-1 event list
|
||||
- [x] finalize the canonical envelope for Phase 1
|
||||
- [x] finalize the phase-1 event list for transcript -> note -> memory
|
||||
- [ ] define versioning rules
|
||||
- [ ] define payload examples for first adopters
|
||||
- [x] define payload examples for first adopters
|
||||
- [ ] define storage and retention expectations
|
||||
- [ ] define producer and consumer validation rules
|
||||
|
||||
Current implementation location:
|
||||
|
||||
- [`packages/events/src/ecosystem.ts`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/src/ecosystem.ts)
|
||||
- [`packages/events/fixtures/ecosystem/phase1`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/fixtures/ecosystem/phase1)
|
||||
|
||||
Commits:
|
||||
|
||||
- `41fa2cd` drafted the initial version
|
||||
- `76f1b47` added Phase 1 event schemas and fixtures
|
||||
|
||||
@ -39,18 +39,18 @@ Example:
|
||||
|
||||
## 2. Core Spec Status
|
||||
|
||||
| Spec | Status | Owner Repo | Notes | Commits |
|
||||
| ---------------------------------------------- | ----------- | ------------------------- | ------------------------------------------------------ | ------------------------------- |
|
||||
| `ECOSYSTEM_CROSS_POLLINATION_OPPORTUNITIES.md` | done | `learning_ai_common_plat` | strategy baseline created and strengthened | `d28e9d0`, `341cde7`, `3e572b6` |
|
||||
| `ECOSYSTEM_SHARED_ARTIFACT_SCHEMA.md` | in-progress | `learning_ai_common_plat` | draft stub exists, schema decisions still open | `eae3409` |
|
||||
| `ECOSYSTEM_AGENT_RUNTIME_CONTRACT.md` | in-progress | `learning_ai_common_plat` | draft stub exists, runtime normalization still open | `eae3409` |
|
||||
| `ECOSYSTEM_APPROVALS_AND_TRUST_MODEL.md` | in-progress | `learning_ai_common_plat` | draft stub exists, policy matrix still needs hardening | `eae3409` |
|
||||
| `ECOSYSTEM_EVENT_TAXONOMY.md` | in-progress | `learning_ai_common_plat` | draft exists, phase-1 event set still needs refinement | `41fa2cd` |
|
||||
| `ECOSYSTEM_OWNERSHIP_MATRIX.md` | in-progress | `learning_ai_common_plat` | temporary four-party ownership model added | `41fa2cd`, `7a86a76` |
|
||||
| `ECOSYSTEM_VERIFICATION_MATRIX.md` | in-progress | `learning_ai_common_plat` | draft verification model added | `41fa2cd` |
|
||||
| `ECOSYSTEM_CONTRACT_TEST_STRATEGY.md` | in-progress | `learning_ai_common_plat` | draft contract-test model added | `41fa2cd` |
|
||||
| `ECOSYSTEM_MARKETPLACE_UNIFICATION.md` | in-progress | `learning_ai_common_plat` | draft exists, inventory and entitlement details open | `7a86a76` |
|
||||
| `ECOSYSTEM_PERSONAL_TIMELINE_PRD.md` | in-progress | `learning_ai_common_plat` | draft exists, hosting and filtering decisions open | `7a86a76` |
|
||||
| Spec | Status | Owner Repo | Notes | Commits |
|
||||
| ---------------------------------------------- | ----------- | ------------------------- | ------------------------------------------------------------------------------------------------------ | ------------------------------- |
|
||||
| `ECOSYSTEM_CROSS_POLLINATION_OPPORTUNITIES.md` | done | `learning_ai_common_plat` | strategy baseline created and strengthened | `d28e9d0`, `341cde7`, `3e572b6` |
|
||||
| `ECOSYSTEM_SHARED_ARTIFACT_SCHEMA.md` | in-progress | `learning_ai_common_plat` | Phase 1 artifact schema and fixtures now exist in `@bytelyst/events`; broader storage rules still open | `eae3409`, `76f1b47` |
|
||||
| `ECOSYSTEM_AGENT_RUNTIME_CONTRACT.md` | in-progress | `learning_ai_common_plat` | draft stub exists, runtime normalization still open | `eae3409` |
|
||||
| `ECOSYSTEM_APPROVALS_AND_TRUST_MODEL.md` | in-progress | `learning_ai_common_plat` | draft stub exists, policy matrix still needs hardening | `eae3409` |
|
||||
| `ECOSYSTEM_EVENT_TAXONOMY.md` | in-progress | `learning_ai_common_plat` | Phase 1 event names and examples now exist in `@bytelyst/events`; broader taxonomy remains open | `41fa2cd`, `76f1b47` |
|
||||
| `ECOSYSTEM_OWNERSHIP_MATRIX.md` | in-progress | `learning_ai_common_plat` | temporary four-party ownership model added | `41fa2cd`, `7a86a76` |
|
||||
| `ECOSYSTEM_VERIFICATION_MATRIX.md` | in-progress | `learning_ai_common_plat` | draft verification model added | `41fa2cd` |
|
||||
| `ECOSYSTEM_CONTRACT_TEST_STRATEGY.md` | in-progress | `learning_ai_common_plat` | draft contract-test model added | `41fa2cd` |
|
||||
| `ECOSYSTEM_MARKETPLACE_UNIFICATION.md` | in-progress | `learning_ai_common_plat` | draft exists, inventory and entitlement details open | `7a86a76` |
|
||||
| `ECOSYSTEM_PERSONAL_TIMELINE_PRD.md` | in-progress | `learning_ai_common_plat` | draft exists, hosting and filtering decisions open | `7a86a76` |
|
||||
|
||||
---
|
||||
|
||||
@ -75,9 +75,12 @@ Example:
|
||||
- [x] Draft approvals and trust model stub
|
||||
Commits:
|
||||
- `eae3409`
|
||||
- [ ] Draft event taxonomy
|
||||
- [x] Draft event taxonomy
|
||||
Commits:
|
||||
- `41fa2cd`
|
||||
- [x] Implement Phase 1 artifact and event contracts in `@bytelyst/events`
|
||||
Commits:
|
||||
- `76f1b47`
|
||||
- [x] Draft temporary ownership matrix
|
||||
Commits:
|
||||
- `41fa2cd`
|
||||
@ -130,11 +133,11 @@ Example:
|
||||
|
||||
## 4. Current Gaps Before Broad Implementation
|
||||
|
||||
- [ ] event taxonomy needs phase-1 event list hardening
|
||||
- [x] event taxonomy phase-1 event list hardened in `@bytelyst/events`
|
||||
- [ ] adoption docs exist for the first flow, but broader repo coverage is still missing
|
||||
- [ ] ownership model is temporary and must be revised if the team changes
|
||||
- [ ] verification matrix needs repo-level test ownership
|
||||
- [ ] contract-test strategy needs fixture location and validation tooling decisions
|
||||
- [x] contract-test strategy fixture location and validation tooling now exist in `packages/events`
|
||||
|
||||
These should be resolved before claiming the ecosystem docs are fully implementation-ready.
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Ecosystem Shared Artifact Schema
|
||||
|
||||
> **Status:** Draft stub
|
||||
> **Status:** Phase 1 baseline implemented
|
||||
> **Owner:** `learning_ai_common_plat`
|
||||
> **Purpose:** Define the canonical cross-product artifact model so notes, transcripts, plans, memories, trails, routes, and agent outputs can interoperate cleanly.
|
||||
|
||||
@ -177,15 +177,21 @@ Phase 1 adopters:
|
||||
|
||||
## 9. Implementation Checklist
|
||||
|
||||
- [ ] finalize canonical envelope field names and required/optional splits
|
||||
- [ ] define first 5 artifact types in stable form
|
||||
- [ ] define link relation vocabulary
|
||||
- [ ] define provenance minimum payload
|
||||
- [x] finalize canonical envelope field names and required/optional splits
|
||||
- [x] define first 5 artifact types in stable form
|
||||
- [x] define link relation vocabulary
|
||||
- [x] define provenance minimum payload
|
||||
- [ ] define storage/binary attachment rules
|
||||
- [ ] define migration strategy for first adopters
|
||||
- [ ] add examples for LysnrAI, NoteLett, MindLyst, Cowork, and ActionTrail
|
||||
- [x] add examples for LysnrAI, NoteLett, and MindLyst
|
||||
- [ ] add examples for Cowork and ActionTrail
|
||||
|
||||
Current implementation location:
|
||||
|
||||
- [`packages/events/src/ecosystem.ts`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/src/ecosystem.ts)
|
||||
- [`packages/events/fixtures/ecosystem/phase1`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/fixtures/ecosystem/phase1)
|
||||
|
||||
Commits:
|
||||
|
||||
- `eae3409` drafted the initial stub
|
||||
- implementation commits: pending
|
||||
- `76f1b47` added Phase 1 artifact schemas and canonical fixtures
|
||||
|
||||
@ -57,29 +57,35 @@ Repo: [`learning_ai_common_plat`](/Users/saravana/BytelystAI/learning_ai/learnin
|
||||
|
||||
### 4.1 Artifact contract hardening
|
||||
|
||||
- [ ] finalize the transcript artifact envelope
|
||||
- [ ] finalize the note artifact envelope expectations
|
||||
- [ ] finalize the memory artifact envelope expectations
|
||||
- [ ] define required provenance fields for the flow
|
||||
- [ ] define `artifact.linked` relation usage for transcript -> note and note -> memory
|
||||
- [x] finalize the transcript artifact envelope
|
||||
- [x] finalize the note artifact envelope expectations
|
||||
- [x] finalize the memory artifact envelope expectations
|
||||
- [x] define required provenance fields for the flow
|
||||
- [x] define `artifact.linked` relation usage for transcript -> note and note -> memory
|
||||
|
||||
### 4.2 Event taxonomy hardening
|
||||
|
||||
- [ ] finalize `capture.transcript.created`
|
||||
- [ ] finalize `artifact.created`
|
||||
- [ ] finalize `artifact.linked`
|
||||
- [ ] finalize `memory.entry.created`
|
||||
- [ ] add one canonical example payload per event
|
||||
- [x] finalize `capture.transcript.created`
|
||||
- [x] finalize `artifact.created`
|
||||
- [x] finalize `artifact.linked`
|
||||
- [x] finalize `memory.entry.created`
|
||||
- [x] add one canonical example payload per event
|
||||
|
||||
### 4.3 Verification/fixture prep
|
||||
|
||||
- [ ] decide fixture location for Phase 1 examples
|
||||
- [ ] create canonical JSON examples for transcript/note/memory artifacts
|
||||
- [ ] create canonical JSON examples for the 4 phase-1 events
|
||||
- [x] decide fixture location for Phase 1 examples
|
||||
- [x] create canonical JSON examples for transcript/note/memory artifacts
|
||||
- [x] create canonical JSON examples for the 4 phase-1 events
|
||||
|
||||
Implementation location:
|
||||
|
||||
- [`packages/events/src/ecosystem.ts`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/src/ecosystem.ts)
|
||||
- [`packages/events/src/ecosystem.test.ts`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/src/ecosystem.test.ts)
|
||||
- [`packages/events/fixtures/ecosystem/phase1`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events/fixtures/ecosystem/phase1)
|
||||
|
||||
Commits:
|
||||
|
||||
- pending
|
||||
- `76f1b47` `feat(events): add phase1 ecosystem contracts`
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -43,3 +43,7 @@ Tracking convention:
|
||||
- implementation checklist
|
||||
- commit-link section
|
||||
- use [`ECOSYSTEM_IMPLEMENTATION_TRACKER.md`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/docs/ecosystem/ECOSYSTEM_IMPLEMENTATION_TRACKER.md) as the portfolio-level progress ledger
|
||||
|
||||
Current implementation package:
|
||||
|
||||
- [`packages/events`](/Users/saravana/BytelystAI/learning_ai/learning_ai_common_plat/packages/events) holds the first concrete ecosystem contract code and canonical Phase 1 fixtures.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user