Skip to content

Commit a2f64a2

Browse files
docs: repoint Getting Started examples to per-repo URLs (#25)
The three worked examples now live in each CLI's repo (docs/example.md): - quantcli/crono-export-cli#47 (merged) - quantcli/liftoff-export-cli#49 (merged) - quantcli/withings-export-cli#40 (merged) Drop the in-tree docs/example-{crono,liftoff,withings}.md copies and point GETTING_STARTED.md "Going further" at the canonical per-repo URLs. Keeps the source of truth next to the code it documents. Co-authored-by: LeadGoEngineer <noreply@paperclip.ing>
1 parent b26c85e commit a2f64a2

4 files changed

Lines changed: 4 additions & 601 deletions

File tree

GETTING_STARTED.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,10 +114,10 @@ All green means the CLI conforms to [CONTRACT.md §3–§4 and §7](CONTRACT.md)
114114

115115
## Going further
116116

117-
- **Worked examples with expected output:**
118-
- [crono-export example](docs/example-crono.md) — nutrition totals, food log, biometrics
119-
- [liftoff-export example](docs/example-liftoff.md) — workouts list, bodyweight trend
120-
- [withings-export example](docs/example-withings.md) — activity, sleep, measurements
117+
- **Worked examples with expected output** (hosted in each CLI's repo):
118+
- [crono-export example](https://github.com/quantcli/crono-export-cli/blob/main/docs/example.md) — nutrition totals, food log, biometrics
119+
- [liftoff-export example](https://github.com/quantcli/liftoff-export-cli/blob/main/docs/example.md) — workouts list, bodyweight trend
120+
- [withings-export example](https://github.com/quantcli/withings-export-cli/blob/main/docs/example.md) — activity, sleep, measurements
121121
- **Contract reference:** [CONTRACT.md](CONTRACT.md) — date flags, output formats, auth model, conformance
122122
- **Conformance library:** [compat/README.md](compat/README.md) — how the machine-attested test bundles work
123123
- **Security policy:** [SECURITY.md](SECURITY.md)

docs/example-crono.md

Lines changed: 0 additions & 202 deletions
This file was deleted.

docs/example-liftoff.md

Lines changed: 0 additions & 181 deletions
This file was deleted.

0 commit comments

Comments
 (0)