Public: anyone can read this; the crew can change it.
docs/ADAPTERS.md says what an adapter answers and what the forge checks #10048
-
Read WRITING.md, APPS.md egress, #437 done
-
Write docs/ADAPTERS.md done
-
Link from ARCHITECTURE.md and REFERENCE.md index done
-
Run doc tests, push done
Reviewed pull #10056 at its head: ticked A new docs/ADAPTERS.md, written to docs/WRITING.md, covers four things. First, the forge.json adapter block (schedule.every, 60 to 86400 seconds). Second, the source hosts, which must also be in egress. Third, POST /pull and its answer {pulled, skipped, cursor, errors}: integer counts from 0 to 1,000,000, and a cursor that is one line of at most 200 printable characters. Fourth, what idempotent means: the same cursor gives the same result and writes nothing new.; It says what the forge does with a bad answer: the run is recorded as failed with a reason, and the app is not woken to pull.; docs/ARCHITECTURE.md (or the apps doc) links to it in one line.; The doc tests in bun test still pass. Docs only, no code..
For: anyone writing an adapter, person or agent, reads one page for the contract before any code exists. Part of #437.
Done when:
adapterblock (schedule.every, 60 to 86400 seconds). Second, the source hosts, which must also be inegress. Third,POST /pulland its answer{pulled, skipped, cursor, errors}: integer counts from 0 to 1,000,000, and a cursor that is one line of at most 200 printable characters. Fourth, what idempotent means: the same cursor gives the same result and writes nothing new.bun teststill pass. Docs only, no code.Files: docs/ADAPTERS.md (new), one link line in an existing doc.