Commit 8a47711
authored
docs(export): correct the bundle layout, the CSV import claim and the tracked-day loss (#999)
* docs(export): correct the bundle layout, the CSV import claim and the tracked-day loss
Checked against origin/release/2.2.0. The CSV column tables are all still exact
-- 41 intake columns, 13 activity, 9 tracked-day, in order -- as is the dialect
section. The layout and the round-trip section were not.
- **The bundle is format-exclusive.** Settings -> Export offers a JSON / CSV
toggle and writes one or the other; no bundle the app produces has ever
carried a CSV next to its JSON counterpart. The doc described a single zip
with both side by side, each CSV a "flat companion" -- so a tool author
unzipping expecting six files finds three. Split into a JSON table and a CSV
table.
- **Four artefacts were missing:** weight_log.json and
custom_activity_templates.json from the JSON bundle, and the recipe_images/
and meal_images/ directories carrying user photos.
- **CSV import shipped.** ImportDataUsecase.importDataCsv reads all three CSVs
and is wired to the same toggle. The doc said the importer "reads the JSON
files and ignores the CSV companions" and offered CSV import as future work
"if there's demand".
- **Tracked days do not round-trip, and the doc promised they did.**
trackedDayColumns has 9 entries against TrackedDayDBO's 19 fields: the ten
per-nutrient goals added by #173 have no column and are dropped. The cited
test does not pin what the doc claimed, because its tracked-day group never
sets them. Now stated, with a pointer to use JSON for restores.
- **"User profile (height, weight, birthday, PAL, goal) is not included"** read
as "your weight data is not in the bundle". The profile box is excluded, but
weight history is exported as weight_log.json. Separated.
Refs #991
* docs(export): photos ship with the JSON bundle only
Copilot caught it, and the code agrees: `_addUserImageIfPresent` sits inside
the `format == ExportFormat.json` branch of `exportData`, and
`importDataCsv` has no image-restore step at all. The page said either bundle
carries them, which would have cost someone their photos on a CSV round trip.
Also prefixes the profile-box path with `lib/`, matching every other path on
the page.1 parent 9a9282b commit 8a47711
1 file changed
Lines changed: 51 additions & 28 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
6 | 6 | | |
7 | 7 | | |
8 | 8 | | |
9 | | - | |
| 9 | + | |
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
34 | 52 | | |
35 | 53 | | |
36 | 54 | | |
| |||
250 | 268 | | |
251 | 269 | | |
252 | 270 | | |
253 | | - | |
| 271 | + | |
254 | 272 | | |
255 | 273 | | |
256 | 274 | | |
257 | 275 | | |
258 | 276 | | |
259 | | - | |
260 | | - | |
261 | | - | |
262 | | - | |
263 | | - | |
264 | | - | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
265 | 288 | | |
266 | 289 | | |
267 | 290 | | |
| |||
0 commit comments