Skip to content

docs: target the searches that coding agents make - #84

Open
cardmagic wants to merge 4 commits into
mainfrom
docs/search-targeting
Open

cardmagic wants to merge 4 commits into
mainfrom
docs/search-targeting

Conversation

@cardmagic

Copy link
Copy Markdown
Owner

Why

On 2026-10-18, a replay of the searches from the agent selection eval found no Solid Objects page for these queries:

  • the five DBOS queries, such as "DBOS TypeScript partitioned queues workflow send recv durable sleep"
  • "Graphile Worker queue_name serial execution job_key run_at"
  • "durable execution TypeScript AI agents Postgres 2026 Restate DBOS Temporal comparison"

Codex search already returns /js/compare/restate for 11 Restate queries and /js/compare/rivetkit for 2 RivetKit queries. Claude Code search returns no solidobjects.dev page for any of the 84 queries, so this change can help only the agents whose search indexes the site.

Changes

  • Add docs/compare/ai-agents.md, "Durable execution for TypeScript AI agents on PostgreSQL: Restate, DBOS, Temporal, and Solid Objects", based on use case N3.
    • One table compares four things for each tool: where the state lives, what a crash repeats, how a delayed follow-up works, and what you run.
    • The page embeds examples/compare/agent-session.ts and examples/compare/agent-runtime.ts. test/compare-agent-session.test.ts already runs them.
    • Each Temporal claim comes from the Temporal docs.
  • scripts/check-documentation.mjs checks the new page: the embedded examples, the dashes, and the hub link.
    • This check failed first with ENOENT ... docs/compare/ai-agents.md.
  • The other pages each answer one new question. Each answer quotes the official docs, checked on 2026-10-18.
    • docs/compare/restate.md: how delayed messages and timers work.
    • docs/compare/dbos.md: how durable sleep, send, and recv work.
    • docs/compare/graphile-worker.md: whether jobs with the same queue_name run serially, with job_key and run_at.
  • The RivetKit page does not change. The Rivet docs do not use the search terms "Postgres driver" or "PostgreSQL driver", because PostgreSQL is only a storage backend of the Rivet control plane.

A separate review agent checked each changed page against its cited sources. Every finding is fixed.

This pull request changes no runtime code. The pages ship with the next docs-only release. The changelog entry is under "Unreleased", and no version commit is in this pull request yet.

Validation

  • pnpm run check: passed.
  • pnpm test: 81 files, 704 passed, 32 skipped.
    • The first full run also reported 1 unhandled rejection, "BroadcastChannel is closed", from src/browser/tab-host.ts:265 during test/tab-host.test.ts.
    • That file failed in 1 of 6 separate runs. Its source and test files are the same as on main, so the rejection does not come from this change.
    • A second full run was clean.
  • pnpm exec prettier --check .: clean.
  • The site route /js/compare/ai-agents builds from a working-tree snapshot, and I checked it at 375 px. It has no horizontal page scroll.

On 2026-10-18, a replay of the searches from the agent selection eval
found no Solid Objects page for the DBOS durable sleep queries, the
Graphile Worker queue_name query, or the general query "durable
execution TypeScript AI agents Postgres". Codex already finds the
Restate page for most Restate queries.

- Add docs/compare/ai-agents.md. One table compares Restate, DBOS
  Transact, Temporal, and Solid Objects: where the state lives, what a
  crash repeats, how a delayed follow-up works, and what you run. It
  embeds the agent session example that the tests run, and the
  documentation check now covers it.
- The Restate, DBOS, and Graphile Worker pages answer the questions
  about delayed messages and timers, durable sleep with send and recv,
  and serial queues with job_key and run_at. Each answer quotes the
  official docs, checked on 2026-10-18.
- A separate review checked each page against its sources. Every
  finding is fixed.
@context7

context7 Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Docs7 for cardmagic/solid-objects-js

Result Status Action
Deployment ➖ Not used —
Content review ➖ Did not run. This site has no agent runs available this month. Wait for the monthly reset or check your Docs7 plan. —

Commit 6aa5d74

@greptile-apps

greptile-apps Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable new issue was found.

Summary

Adds a comparison page for TypeScript AI agents and focused answers about DBOS, Restate, and Graphile Worker.

  • TypeScript agent teams can compare four durable execution tools on one page.
  • The DBOS page explains how durable waits and workflow messages work.
  • The Graphile Worker page explains named queues, job keys, and run times.
  • The Restate page explains when delayed work holds up later calls.

Reviews (3) · Last reviewed commit: "Merge origin/main into docs/search-targe..." · Reviewed by Greptile

Comment thread docs/compare/dbos.md Outdated
this.schedule({ at, key }) with no operation after it fails the turn
with ScheduleWithoutOperation. The bullet now shows the operation call.
@cardmagic

Copy link
Copy Markdown
Owner Author

@greptileai Please review the current head a71ff76. Finding 1: the DBOS bullet now shows the full call, this.schedule({ at, key }).operation(input).

Keep both Unreleased changelog entries. The new comparison pages now use
the 1.0.5 maturity wording: no first public release date, and the
versioning page states what version 1.0 does not claim.
@cardmagic

Copy link
Copy Markdown
Owner Author

@greptileai Please review the current head fe56a0b. It merges main (1.0.5) into the branch. The changelog keeps both Unreleased entries, and docs/compare/ai-agents.md now uses the 1.0.5 maturity wording of the other comparison pages.

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