Skip to content

Docs site: the OpenFn adaptors explanation is published in draft with an unresolved evidence TODO #1096

Description

@jeremi

What

docs/site/src/content/docs/explanation/openfn-adaptors.mdx is published with status: draft and carries an unresolved TODO[evidence] comment saying its claims cannot be anchored from this repository because the adaptor source lives elsewhere. The page nevertheless makes concrete statements about adaptor operations, configuration, failure branches and a pilot topology. A reader has no way to tell which of those statements are current, and the draft marker is the only signal.

Evidence

  • docs/site/src/content/docs/explanation/openfn-adaptors.mdx frontmatter, line 5: status: draft.
  • The same file, lines 22 to 27: {/* TODO[evidence]: adaptor behaviour, operation lists, result branches, and pilot topology live in the separate registrystack/openfn-language-registry-stack repository and cannot be anchored from this one. ... Re-verify them when that repository changes. */}
  • The page's own text says the preserved pilot "is not a runnable current-source example" and that the 0.1.0 beta packages only two of the three adaptors.

Proposed fix

Decide one of two paths. Either give the page a checkable anchor (a pinned tag or digest of the adaptor repository plus a replayable check that the operation lists still match) and graduate it to current, or take it out of the published navigation until the adaptor repository can be gated from here. Related but distinct: #940 and #236.

Found while

Extracting reusable App Kit skills against Registry Stack v0.32.0.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions