Repository navigation
docs(reference): rewrite the SDK and CLI pages as scannable references - #553
Merged
Merged
Conversation
aicayzer
commented
Oct 21, 2026
aicayzer
left a comment
Contributor
Author
There was a problem hiding this comment.
Review: ready to merge
Summary. Rewrites the Swift SDK, CLI and TypeScript SDK pages as shorter references; one wrong Swift fact and several cut or overstated facts are fixed, every inbound link resolves, and each page is shorter than on main.
First draft: 3/5. 1 blocking issue and 5 quick fixes, all fixed in 83e0cb7.
Checked.
- True: every type, case and signature on the Swift page against marfa-swift v0.0.24 (
BlockedReason,Keychain.system, all 31MarfaErrorcases,Change.Origin,FolderEvent,FileState,LiveQuery,Following); the keychain table and sections againstcore/marfa-cliat v0.0.20, withoperations,whoamiandkeys forgetrun on the v0.0.20 build; the contract-mismatch text against the TypeScript client. - Every path: every link into
/cli,/swift-sdkand/typescript-sdkresolves after merging main.
Found.
- The edge-move refusal rule was backwards. A move is refused where the staying end holds more than one edge of the type. Fixed in 83e0cb7.
Untrue against marfa - A missing keychain file:
login,logoutandkeys forgetalso exit 4. Fixed in 83e0cb7.Untrue against marfa folders watchhonoursMARFA_KEYCHAINin a shell; only the login agent uses the default keychain. Fixed in 83e0cb7.Untrue against marfaKeychainandServer.fromEnvironmentthrow their own error types, notMarfaError. Fixed in 83e0cb7.Untrue against marfa- Facts an agent needs were cut: the remaining
MarfaErrorcases,Edges.updatereturningnil,invalid_properties, the purge permissions,fromEnvironment's throw,original(ofConflictedCopy:)returning an ID, and whenblobs.getfetches. Restored in 83e0cb7.Untrue against marfa
Quick fixes. 9 applied by the reviewer.
Reviewed by withmarfa-reviewer on claude-opus-5-5. This review may contain mistakes.
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.
Summary
Rewrites the Swift SDK, CLI and TypeScript SDK reference pages so each one leads with install and then lists the API by area, with every command's output captured from a real v0.0.20 server. Each page ends shorter than on
main.Changes
Verdict,BlockedReason,withdraw,release).BlockedReasonhas five cases in marfa-swift v0.0.24. The contract's sixth reason,awaiting_dependency, is shown asQueuedWrite.waitingwith no verdict (queue-and-verdicts/binding-shows-waiting), so the page says so. Devices keeps the six-reason table.login,logout,keys keepandkeys forget.marfa operations,marfa whoamiandsetup statususe<Terminal>. Themarfa profile updateparagraph is dropped (it lives on Authenticate). Every heading other pages link to is kept.<Terminal>.Testing
pnpm test,pnpm build,pnpm build:statusandpnpm types:checkpass.pnpm devat desktop and 375 px width (no horizontal page scroll), and read each.mdcopy.@withmarfa/client.--socketwithMARFA_API_URLexits 2;marfa eventsthrough the socket exits 5;MARFA_NO_KEYCHAINtakes1,true,yesandon;marfa loginrefuses while a key is kept.Notes for reviewers
whoamioutput: the server line readshttps://marfa.example.comin place of the local address it printed. The rest is as printed.X-Marfa-Contractto1, because no released server speaks another contract.MARFA_KEYCHAINfile ends any command with exit code 4. Run for real,marfa statusreports no credential, andmarfa keys keeprefuses with exit code 4. The page now says that.core/marfa-cli/COMMANDS.md, not here.Checklist
src/generated/or toopenapi.jsonmain