Skip to content

docs: reposition as the live rules engine for AI agents - #243

Merged
jsam merged 1 commit into
mainfrom
fm/align-readme
Oct 4, 2026
Merged

jsam merged 1 commit into
mainfrom
fm/align-readme

Conversation

@jsam

@jsam jsam commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Repositions the repo around the category approved on 2026-10-04: the live rules engine for AI agents, h1 "Take the rules out of your prompts.", bold line "Your agents act on what's true now." (source: gtm-tagline report §2–4 and §9, with the challenger's factual fixes applied).

What changed

  • README.md: the first screen follows report §4.2: category line, h1, bold line, definition, Replaces/Keeps, Where it sits, the hero, the no-model caption and the scope line. Below the fold follows §4.5: what it does, how it recovers, the stack line ("Models think. InputLayer knows." moves here), what you delete, before/after table, the agent loop with a model, proof points, get started/SDKs, IQL under the hood, ontologies, who it is for.
  • Unshipped API is labelled. The hero uses subscribe()/claim() (SDK phase 1, not merged) and sits under an "upcoming SDK" note. A new What runs today section shows the same rule on today's Python SDK, the WebSocket standing query and its deltas, and the engine's .why proof.
  • Challenger fixes applied: workflow-id dedupe moves to Keeps (Temporal's workflow id becomes the claim key). Replaces names "already handled" rows and claimed_by columns; TTL locks are left to WorkQueue leases in phase 3. Crons that wait on time keep a clock writer. Staleness is an explicit lease guard. kg.why() from Python is not shown as working; the engine's .why is. Also: "when", not "the moment"; the scope line says "in progress (draft)" and links feat(protocol): share evaluations across standing queries that differ only in bound constants, and cache their plans #232; no "carries a proof"; no "one per tenant".
  • SDKs: Python README intro rewritten. TypeScript SDK README added (it was missing from files). pyproject and package.json descriptions and keywords updated.
  • Other places the category appears: the Cargo description and keywords (5, the crates.io limit), the inputlayer-server --help banner, docs/README.md and the docs landing page docs/content/index.mdx.

Verification

Run against a main-equivalent engine (c166f94 binary) in a scratch lab:

  • The README "What runs today" Python block, extracted verbatim, printed late/killed/restored as shown.
  • A .subscribe needs ?check_needed(Order, Shipment) session got a snapshot, then a delta retracting the row on +kill_switch and one re-inserting it on -kill_switch.
  • .why ?check_needed("ORD-4821", S) returned the proof tree that is abridged in the README.
  • The JS README quick start, extracted verbatim and run against a tarball built with npm pack and installed with npm install inputlayer@file:…, printed the rows shown in its comments.
  • The flights example's output is now in the order the engine returns. The il subcommands work and il search lists consistency-core.
  • Every inputlayer.ai docs link returns 200. ghcr.io/inputlayer/inputlayer:latest resolves. cargo metadata passes, and the pyproject and package.json files parse.

Removed or redirected links

Not in this PR

  • The website (front/, report §4.6) still uses the old category in about a dozen places.
  • The GitHub repo description still says "Live knowledge graph for AI agents" (repo settings).

Found while verifying (SDK, not changed here)

Rewrite the README first screen around the approved category (the live
rules engine for AI agents; Take the rules out of your prompts.): the
definition, what it replaces and keeps, where it sits, the upcoming-SDK
hero clearly labelled, and the scope line. Add a What runs today section
with code verified against a live engine, and reorder below the fold.

Align the Python SDK README, add a TypeScript SDK README, and update the
package descriptions and keywords, Cargo description, server banner,
docs/README.md and the docs landing page to the same category.
@jsam
jsam merged commit 5459478 into main Oct 4, 2026
20 checks passed
@jsam
jsam deleted the fm/align-readme branch October 4, 2026 13:10
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