help, README: link the topics, spell out the JSON documents and waiting - #16
Merged
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
ark help agentsand each help topic to its source under src/help, so a reader on GitHub can open them without installing the tool.ark --json --versionas the way to read the tool version that scripts should pin.ark status --json, where no-device means none is attached yet.ark help agentsfirst.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.versionand whenunlockedis 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.