docs: 1.0.0-rc.0 source reconciliation (Branch A)#1
Merged
Conversation
…s A) Groups 4/5/6/7 of MECHANICAL_RESOLUTION_SUMMARY.md. Each edit aligns the docs to a surface that already exists in @loop-engine/* source today, or to a decision already locked in API_SURFACE_DECISIONS_RESOLVED.md. Taxonomy + nav (Groups 5/7): - packages/index.mdx: drop @loop-engine/playground from taxonomy and remove the false "internal, not published" claim for core primitives (R-181, R-182). - getting-started/installation.mdx: list all 22 currently published packages, grouped by layer (R-180). Experimental boundaries + error surface (Group 6): - packages/dsl.mdx: mark LoopBuilder.guard / .signal / .priorityRule as 1.1.0+ experimental (R-112); type ValidationResult/ValidationError explicitly (R-115). - packages/guards.mdx: document GuardRegistry.registerBuiltIns() and drop fictional createEvaluator() (R-090); fix the built-in guards list to match registry source. - packages/registry-client.mdx: document RegistryNotFoundError, RegistryConflictError, RegistryNetworkError (R-143). Source-canonical rewrites (Group 4): - packages/events.mdx: LOOP_EVENT_TYPES content matches source; correct extractLearningSignal signature (R-103, plus parameter list). - running-loops/event-subscriptions.mdx: align event type list and loop.completed example payload to actual source. - packages/observability.mdx: complete LoopMetrics field list (R-115 type-shape adjacent). - packages/actors.mdx: actor field shapes match @loop-engine/actors source — drop fictional WebhookActor / SystemActor and gatewaySessionId (D-05 → A). - packages/core.mdx and packages/runtime.mdx: drop orgId from LoopInstance and LoopStore.listOpen* (D-06 → A). - getting-started/quick-start.mdx: drop orgId and the invalid "system" actor type from the runnable example. - packages/signals.mdx: rewrite to current SignalRegistry surface; scope SignalEngine + built-in rule factories as 1.1.0+ roadmap (R-114 group; honors D-20 → C deferral). Refs: oss-repackaging--02a-mechanical-pass-a.md
Co-commit pair to loop-engine SR-001. Per resolution log D-07 the runtime engine class is now LoopEngine and the engine method startLoop is now start; update the docs site references that still used the old names. Changes: - components/home/CodeTabs.tsx: engine.startLoop -> engine.start in the homepage runnable snippet - content/docs/integrations/openclaw.mdx: configuration table now types loopSystem as LoopEngine (was LoopSystem) - content/docs/packages/sdk.mdx: re-export bullet now states that createLoopSystem is the SDK auto-wired aggregate and that the runtime factory createLoopEngine lives in @loop-engine/runtime, matching the resolution log explicitly (the SDK does not re-export createLoopEngine) What is intentionally left alone: - All createLoopSystem references that import from @loop-engine/sdk (the SDK retains createLoopSystem per D-07; this is intentional product naming, not an alias) - The page running-loops/create-loop-system.mdx, which documents the SDK factory and is correct as written Verification: - npx tsc --noEmit: green Cross-repo pair: loop-engine commit 6241eac. Surface-Reconciliation-Id: SR-001
Updates loopengine.dev pages that referenced the pre-rename LoopStorageAdapter / createMemoryLoopStorageAdapter / storage option key. Pages already in post-rename state (packages/runtime.mdx, packages/sdk.mdx, packages/adapter-memory.mdx, packages/ adapter-postgres.mdx, running-loops/adapters.mdx, running-loops/ create-loop-system.mdx, getting-started/installation.mdx, llms.txt) become correct without edits via the source rename — no churn. Updates in this commit: - components/home/CodeTabs.tsx: homepage Run + Events snippets switch to memoryStore() and store option key; syntax highlighter symbol list updated - content/docs/integrations/index.mdx: prose reference LoopStorageAdapter -> LoopStore - content/docs/integrations/http.mdx: two prose references LoopStorageAdapter -> LoopStore - content/docs/integrations/postgres.mdx: prose reference LoopStorageAdapter -> LoopStore - content/docs/examples/postgres-persistence.mdx: code sample updated (memoryStore factory, postgresStore factory, store option key); trailing prose reference LoopStorageAdapter -> LoopStore Verification - npx tsc --noEmit: clean - pnpm lint: clean - pnpm build: 12/12 pages prerendered, no MDX parse errors Surface-Reconciliation-Id: SR-002
Class 4B paired docs commit for SR-003 (loop-engine `6843194`). Updates the five MDX pages that referenced the `LLMAdapter` interface to instead reference `ToolAdapter`, matching the post-rename source state in `@loop-engine/core`. The five pages: - `content/docs/integrations/index.mdx` - `content/docs/changelog.mdx` (Unreleased section only; becomes the 1.0.0-rc.0 entry) - `content/docs/ai-and-automation/ai-as-actor.mdx` (two references) - `content/docs/integrations/perplexity.mdx` - `content/docs/packages/adapter-perplexity.mdx` The four other AI provider pages (Anthropic / OpenAI / Gemini / Grok) are untouched here. Their re-homing onto `ActorAdapter` is a separate Phase A.3 work item (D-13 secondary; not part of SR-003's narrow scope). Verification: `npx tsc --noEmit` green; `pnpm lint` green; `pnpm build` green (12+ routes prerendered, no MDX parse errors). Surface-Reconciliation-Id: SR-003
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Paired docs updates for the
loop-engine1.0.0-rc.0surface reconciliation (Branch A). Aligns the docs site with post-reconciliation names, shapes, and archetypes.Merge-commit, not squash — the SR trailer chain mirrors
loop-engine's audit history and is load-bearing for cross-repo paired-commit verification.Commits
63820f6a1667caLoopEnginerename (D-07) — SR-00241d6f1aLoopStorecollapse and rename (D-11) — SR-0034559291ToolAdapter(D-13)Three
Surface-Reconciliation-Idtrailers present (SR-001/002/003); later Branch A SRs landed without paired docs commits per SR-by-SR scoping. Full Branch B docs alignment is a follow-on phase.Merge context
loopengine.devmerges alongside loopengine/loop-engine#1.main; verify the paired pages reflect post-reconciliation shapes.Non-goals
Branch B (full docs alignment for SR-004 → SR-019) is a separate follow-on phase, not in scope for this PR.
Merge instructions