Skip to content

help, README: link the topics, spell out the JSON documents and waiting - #16

Merged
karalabe merged 3 commits into
dark-bio:mainfrom
karalabe:help-json-shapes
Sep 22, 2026
Merged

karalabe merged 3 commits into
dark-bio:mainfrom
karalabe:help-json-shapes

Conversation

@karalabe

@karalabe karalabe commented Sep 22, 2026 •

Copy link
Copy Markdown
Member
  • The README links ark help agents and each help topic to its source under src/help, so a reader on GitHub can open them without installing the tool.
  • The output topic shows the stdout error document, a single error key around the code and message, with the real no-device example. It also names ark --json --version as the way to read the tool version that scripts should pin.
  • The states topic says that status nests hardware (version, revision, model) and firmware (version, published), and that synced, paired and unlocked are null on firmware older than the tool supports.
  • The agents topic says nothing in ark waits for an Ark to appear, so a script polls ark status --json, where no-device means none is attached yet.
  • The root help's closing line and the README tell AI agents, not scripts, to read ark help agents first.
  • Four topic source lines over 80 columns are reflowed with the words unchanged. The renderer wraps each source line on its own, so they printed raggedly.

Agents asked to write a script that waits for an Ark and prints its firmware version and lock state from --json all read the CLI's source or the published crate to find .error.code, .firmware.version and when unlocked is null, and most searched the help for a wait option that does not exist. Some also noted that the agents topic was only readable by running the binary.

Whether device-busy, device-unreachable and disconnected also mean "keep waiting" while an Ark is plugged in or boots needs checking on hardware first, so only no-device is named. datasets.md still has a colon elaboration ("snp-indel-calls first: the owner must upload"), left as written since the reflow keeps the words.

karalabe and others added 3 commits September 22, 2026 09:53
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
@karalabe karalabe changed the title help, README: link the topics and spell out the JSON documents help, README: link the topics, spell out the JSON documents and waiting Sep 22, 2026
@karalabe
karalabe merged commit 4de7c1e into dark-bio:main Sep 22, 2026
8 checks passed
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