Skip to content

docs: add worked example for withings-export#40

Merged
DTTerastar merged 1 commit into
mainfrom
docs/worked-example
May 25, 2026
Merged

docs: add worked example for withings-export#40
DTTerastar merged 1 commit into
mainfrom
docs/worked-example

Conversation

@Terastar-Paperclip
Copy link
Copy Markdown
Contributor

Summary

Adds docs/example.md — the worked example for withings-export. Originally landed in quantcli/common#24; moved here because per-CLI examples belong next to the binary they document (per-repo ownership, no cross-repo drift when flags change).

Companion PRs:

Tracking issue: QUA-45 (Docs & Education onboarding #1, delivers AC #3 of QUA-5).

Test plan

  • All commands in docs/example.md were executed at HEAD against locally built binaries during the original PR #24 work — including the full compat suite (stub server + fake token)
  • Cross-repo links rewritten to absolute https://github.com/quantcli/... URLs (verified no ../ relative links remain)
  • No CONTRACT §X paraphrasing — citations are anchor-only and point at canonical sections
  • No hard tabs (MD010-clean)

Moves the withings-export worked example out of quantcli/common (where
it was misfiled in PR #24) and into this repo where it belongs — next
to the binary it documents. Co-references in GETTING_STARTED.md will
be updated in a follow-up PR against quantcli/common.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@DTTerastar DTTerastar merged commit 7127367 into main May 25, 2026
8 checks passed
@DTTerastar DTTerastar deleted the docs/worked-example branch May 25, 2026 18:53
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.

3 participants