glm-5.1
2b63cda1c7
Copy architecture docs, ADRs, storage domain specs, research, reviews, and 56 storage architecture tasks from the alkhub_ts monorepo. Adapt for standalone @alkdev/hub repo structure (src/ not packages/hub/). Sanitize all sensitive information: - Replace private IPs (10.0.0.1) with localhost defaults - Remove internal server hostnames (dev1, ns528096) - Replace /workspace/ private paths with npm package references - Remove hardcoded credentials from examples - Rewrite infrastructure.md without private network details Add Deno project scaffolding: deno.json (pinned deps), .gitignore, AGENTS.md, entry point. Migrate existing code stubs (crypto, config types, logger) with updated import paths.
62 lines
3.0 KiB
Markdown
62 lines
3.0 KiB
Markdown
---
|
|
id: update-agents-and-overview
|
|
name: Update AGENTS.md and overview.md for Extraction
|
|
status: completed
|
|
depends_on: []
|
|
scope: moderate
|
|
risk: low
|
|
impact: component
|
|
level: implementation
|
|
---
|
|
|
|
## Description
|
|
|
|
Update the two highest-visibility project orientation docs to reflect that operations, pubsub, and mcp are now external npm packages, not in-repo code. These are the docs that developers and agents read first.
|
|
|
|
### AGENTS.md changes
|
|
|
|
**Provenance table** — Replace all "Copied from predecessor project" / "Forked from graphql-yoga" / "Not started" entries:
|
|
|
|
| Module | Current Status | Updated Status |
|
|
|--------|---------------|----------------|
|
|
| Operations system | "Working, 7 tests passing" | Extracted to `@alkdev/operations` v0.1.0 |
|
|
| PubSub (createPubSub) | "Working" | Extracted to `@alkdev/pubsub` v0.1.0 |
|
|
| PubSub (operators) | "Working" | Extracted to `@alkdev/pubsub` v0.1.0 |
|
|
| TypedEventTarget | "Forked from graphql-yoga" | Extracted to `@alkdev/pubsub` v0.1.0 |
|
|
| Redis EventTarget | "Working, 5 tests passing" | Extracted to `@alkdev/pubsub` v0.1.0 |
|
|
| WebSocket EventTarget | "Not started" | Implemented in `@alkdev/pubsub` v0.1.0 |
|
|
| MCP client | "Working, 1 test passing" | Extracted to `@alkdev/operations/from-mcp` v0.1.0 |
|
|
| Call protocol | "Not started" | Implemented in `@alkdev/operations` v0.1.0 |
|
|
| Config types | "Needs hub config" | Relocated to hub package |
|
|
| Logger | "Needs proper config" | Relocated to hub package |
|
|
| Storage | "Not started" | Not started (unchanged) |
|
|
|
|
**Key Patterns section** — Update to reference `@alkdev/operations` and `@alkdev/pubsub` instead of in-repo code. Add taskgraph pattern. Add ResponseEnvelope.
|
|
|
|
**Workspace Structure** — Remove `core/` package. Add external deps section.
|
|
|
|
**Reference Dependencies table** — Add `@alkdev/operations`, `@alkdev/pubsub`, `@alkdev/taskgraph`. Remove `graphql-yoga`. Update `graphology` note to transitive dep.
|
|
|
|
**Constraints section** — Add constraint: do not duplicate code from `@alkdev/*` packages in-repo.
|
|
|
|
### overview.md changes
|
|
|
|
**"What Exists" section** — Replace entirely with current state (extracted packages at v0.1.0, remaining stubs still in packages/core/).
|
|
|
|
**"What Needs Implementation"** — Remove WebSocket EventTarget, Call protocol (both done). Add taskgraph integration. Keep everything else.
|
|
|
|
**Architecture Docs section** — Update descriptions of operations, pubsub, call-graph docs.
|
|
|
|
## Acceptance Criteria
|
|
|
|
- [ ] AGENTS.md provenance table reflects extraction to npm packages
|
|
- [ ] AGENTS.md key patterns reference `@alkdev/operations` and `@alkdev/pubsub`
|
|
- [ ] AGENTS.md workspace structure removes `core/` from packages list
|
|
- [ ] AGENTS.md reference dependencies table includes 3 new packages and removes graphql-yoga
|
|
- [ ] overview.md "What Exists" lists npm package locations
|
|
- [ ] overview.md "What Needs Implementation" removes completed items
|
|
- [ ] All internal cross-references between docs are consistent
|
|
|
|
## References
|
|
|
|
- docs/reviews/core-library-extraction-sync-2026-05-18.md (Section 2.1, 2.2) |