Skip to content

docs: align queue contracts and operational guidance - #193

Merged
egeominotti merged 2 commits into
mainfrom
docs-audit-polish
Nov 14, 2026
Merged

egeominotti merged 2 commits into
mainfrom
docs-audit-polish

Conversation

@egeominotti

@egeominotti egeominotti commented Nov 14, 2026 •

Copy link
Copy Markdown
Owner

Summary

Current guides could recommend synchronous TCP operations that return local snapshots or no-op results, and promise stronger durability, retry and deduplication guarantees than the implementation provides. Correct public guides, API/protocol pages, engineering references and product agent references against the actual source.

  • Use authoritative async DLQ and cleanup APIs; repair stale method/type names and the workflow classifier example.
  • Explain accepted-prefix bulk admission, actual retry timing, cooperative processor cancellation, configuration fallbacks and payload/webhook validation boundaries.
  • Separate buffered SQLite exposure from durable admission and power-loss guarantees. Describe ownership-fenced disconnect recovery for memory/SQLite and PostgreSQL independently.
  • Document the 50,000-entry memory/SQLite custom-ID ownership cache, PostgreSQL database authority and independent flow ID validation. Require reconciliation after uncertain/partial admission; track live-ID reuse after eviction as a separate reproduce-first runtime investigation.

Type of change

  • Documentation only

Compatibility

These are corrections to descriptions of existing APIs, scheduling, durability and recovery. There is no runtime API, wire protocol, schema, environment, default or behavior change and no migration. SDK implementation, tests, tooling, layout, generated API trees and historical release/benchmark measurements are unchanged.

How was this tested?

  • Fresh disposable native Ubuntu 24.04 Machine: unit 12,062 pass / 0 fail / 404 skip; TCP 69/69 suites, 553/553 checks; embedded 43/43 suites, 349/349; tinyfs 9/0; typecheck and format clean. Machine deleted and logs copied. The later delta is documentation/state only, independently classified against that Machine tree and the prior passing sandbox tree.
  • Site build/discovery: 390 content pages, 914 HTML files, 115 full-text pages, 389 sitemap URLs and six inlined sources. Rendered crawl: 91,309 local links and 10,477 assets, no missing targets/fragments/assets or duplicate IDs; 1,302 source-relative Markdown links and 81 engineering anchors resolve.
  • Host diagnostic docs/harness readers: 422/0; final state readers: 28/0. Docs data: 64 tracked assets; release-post check: 259; startup green. Representative desktop/mobile inspection in both themes, including keyboard search.

No prose-mirroring tests were added. A new sandbox, explicit model campaign and SDK sandbox are not triggered by this documentation-only change; prior sandbox evidence is preserved by the classified delta. The content audit is source-qualified; live third-party/provider integrations and runtime cache-eviction manifestations were not executed.

Exact-head source CI43597962861 and final candidate CI43599592858 are GREEN on attempt1, each with 26 successful jobs and nine expected release skips. Independent pre-commit and pre-push skeptic reviews passed for both commits.

Checklist

  • Technical docs under docs/ updated in this change
  • docs/src/content/docs/changelog.md updated
  • No secrets, credentials or real job payloads in code, tests or logs
  • Commit messages are specific and in English

@vercel

vercel Bot commented Nov 14, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Nov 14, 2026 1:25pm UTC

@claude

claude Bot commented Nov 14, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

@egeominotti
egeominotti merged commit 732c1fb into main Nov 14, 2026
39 checks passed

This branch was successfully deployed

1 active deployment
Preview — 537e4dc5 Deployed Nov 14, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant