docs: Getting Started + three worked examples (crono / liftoff / withings)#24
Merged
Merged
Conversation
- GETTING_STARTED.md: zero-to-first-export guide for all three CLIs; covers install, auth, date flags, output formats, and conformance verification. Links to CONTRACT.md and compat/README.md. - docs/example-crono.md: crono-export worked example with verified --help, prime, auth status, and flag-validation output. - docs/example-liftoff.md: liftoff-export worked example with verified --help, prime, auth status output, and compat suite instructions. - docs/example-withings.md: withings-export worked example with verified --help, prime, auth status output, and full compat suite instructions (stub server, fake token, all §4 cells machine-attested). All commands executed at HEAD (2026-05-19) against locally built binaries. Data-path examples show expected output shape; live output requires real credentials. CONTRACT.md citations are verbatim grep- verified; no fabricated §X references. Co-Authored-By: Paperclip <noreply@paperclip.ing>
CI's markdown-lint check (markdownlint-cli2 v0.13.0) flagged literal tabs from captured `go test` output inside fenced code blocks in the three worked examples. Replace tabs with spaces; visual alignment is preserved, content is unchanged. Co-Authored-By: Paperclip <noreply@paperclip.ing>
DTTerastar
approved these changes
May 19, 2026
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
prime, auth per CLI, date flags,--format, and how to run the conformance suite. Links to CONTRACT.md and compat/README.md.primeoutput, nutrition export, food-logjqrecipe, biometrics query, flag-validation demonstration, compat suite run.primeoutput, workouts list, bodyweight trend, compat suite run (parse-level; data-path skipped pending CI credential provisioning).primeoutput, activity/sleep/measurements exports, full compat suite run (stub server + fake token; all §4 cells machine-attested).Verification
All commands executed at HEAD against locally built binaries:
CONTRACT.md citations are verbatim (grep-verified). No fabricated §X references.
Content lenses applied
primeand CONTRACT.md.Reviewer
Awaiting DT (board) approval click. Shared GH identity means self-approval is blocked.