-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
503 lines (395 loc) · 23.9 KB
/
docs.html
File metadata and controls
503 lines (395 loc) · 23.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation - WeedTracker</title>
<link rel="stylesheet" href="style.css">
</head>
<body>
<!--
== WeedTracker Reusable Header ==
Paste this at the top of any <body> block
-->
<header>
<h1>WeedTracker</h1>
<nav>
<a href="index.html">Home</a>
<a href="docs.html">Documentation</a>
<a href="privacy.html">Privacy Policy</a>
<a href="support.html">Support</a>
<a href="https://apps.apple.com/us/app/weedtracker/id6747688979">Get The App</a>
</nav>
</header>
<main>
<h2>Documentation Index</h2>
<p>This page will grow to include detailed documentation for WeedTracker features. Below is a placeholder index of topics.</p>
<ul>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#adding-strains">Adding and Managing Inventory</a></li>
<li><a href="#search-filter">Searching and Sorting</a></li>
<li><a href="#logging-usage">Viewing Your Usage History</a></li>
<li><a href="#chart">Viewing Your Usage Chart</a></li>
<li><a href="#customizing">Customizing Tier Levels and Types</a></li>
<li><a href="#export-import">Exporting and Importing Data</a></li>
<li><a href="#icloud-sync">iCloud Sync and Multi-Device Use</a></li>
<li><a href="#clearing-data">Clearing Your Data</a></li>
<li><a href="#app-settings">App Settings</a></li>
<li><a href="#faq">FAQ and Troubleshooting</a></li>
</ul>
<hr>
<!-- BEGIN GETTING STARTED -->
<h3 id="getting-started">Getting Started</h3>
<p>Welcome to WeedTracker! This guide will walk you through the basics of setting up your inventory. As you add, adjust, or remove items, the app automatically builds a complete history of your usage — no extra steps required.</p>
<h4>1. Add Your First Strain</h4>
<p>Tap the <strong>+</strong> button to add a new item to your inventory. You can give it a name (e.g., “Blue Dream”), and enter the cost and quantity. Optionally, you can assign a tier (like “Premium” or “Budget”), select a type (e.g., Flower, Concentrate, Edible), and even attach an image for quick visual reference.</p>
<h4>2. Customize Tier Levels And Types (Optional)</h4>
<p>WeedTracker lets you define your own tiers and item types to match the categories used by your local dispensaries. These can be managed from the Settings screen, and any changes will apply automatically across your inventory.</p>
<h4>3. Inventory Adjustments Are Automatically Tracked</h4>
<p>Whenever you create a new strain, restock an item, use something from your inventory, or delete a strain entirely, WeedTracker automatically logs the change as a transaction. These transaction records form your usage history — no need to manually log anything.</p>
<p>You can view each transaction's details, including the date, amount changed, new totals, and any notes you added. This helps you keep an accurate history of your habits and inventory movement over time. You can access your usage history from the App main menu.</p>
<h4>4. View Usage History</h4>
<p>Choose <strong>View History</strong> from the main menu to see a log of all your automatically recorded transactions. You can filter the list by transaction type, date range, or keyword match across strain names and notes, making it easy to find what you're looking for.</p>
<p>The history view gives you a clear, scrollable record of all changes to your inventory, including the date, action taken, quantity adjusted, and any notes entered at the time.</p>
<h4>5. Visualize Your Usage History With The Usage Chart</h4>
<p>To view your usage history chart, select <strong>View Chart</strong> from the main menu.</p>
<p>WeedTracker includes a built-in bar chart that gives you a quick, visual snapshot of how your inventory is changing over time.</p>
<p>The chart shows totals for new items added, stock increases, stock used, deleted strains, and overall increases or decreases — all based on your current date filter. Each bar is color-coded and labeled for easy comparison, and the exact quantity values are shown right on the chart.</p>
<p>This view is perfect for spotting trends at a glance, without scrolling through your full transaction history. It’s a great way to stay aware of your habits and see how your usage adds up over time.</p>
<h4>6. Set Low Stock Warnings</h4>
<p>You can set a low stock warning threshold from the <strong>App Options</strong> screen, available in the main menu. Once enabled, WeedTracker will alert you when your total inventory level drops below that quantity. (You will receive a pop up warning, and the total grams will be shown in red.)</p>
<p>This helps you stay on top of your supply without the need to constantly check levels manually — a simple way to avoid running out unexpectedly.</p>
<h4>7. iCloud Sync & Backups</h4>
<p>Your data is stored privately on your device and can sync across all your Apple devices using iCloud (if enabled). You can also export your data as text or CSV files and import it later, ensuring you always have access to your records.</p>
<h4>See the screen shots below for an overview of the main inventory functionality.</h4>
<p class="caption headline">Inventory View (iPhone)</p>
<a href="images/iPhone_main_view_annotated.png" target="_blank">
<img src="images/iPhone_main_view_annotated.png"
alt="Inventory view on iPhone"
class="doc-image"">
</a>
<p class="caption">On iPhone, the main inventory screen shows your strains in a single-column list. Tap the <strong>+</strong> button in the top-right to add a new item.</p>
<p class="caption headline">Inventory View (iPad)</p>
<a href="images/iPad_main_view_annotated.png" target="_blank">
<img src="images/iPad_main_view_annotated.png"
alt="Inventory view on iPad"
class="doc-image"">
</a>
<p class="caption">On iPad, the main view uses a two-column layout: the list appears on the left, and the selected item’s details appear on the right.</p>
<h4>8. Sample Data</h4>
<p>
Want to explore the app with sample data?<br>
You can load sample inventory and history records in two ways:
</p>
<ul>
<li>From the <strong>initial startup screen</strong></li>
<li>Or later via <strong>Menu → Create Sample Data</strong></li>
</ul>
<p>
This is a great way to try out the app’s features before entering your own data.
</p>
<p>
<em>When you're ready, you can remove sample data — or all data — by visiting the
<a href="#clearing-data"><strong>Clearing Your Data</strong></a> section.</em>
</p>
<hr>
<!-- END GETTING STARTED -->
<!-- BEGIN ADDING AND MANAGING INVENTORY -->
<h3 id="adding-strains">Adding and Managing Inventory</h3>
<p>To add a new item to your inventory, tap the <strong>+</strong> button. A form will appear where you can enter details like the strain name, quantity, cost, product type (such as Flower or Concentrate), and tier (e.g., Premium, Budget). You can also attach an image if you’d like a quick visual reference.</p>
<p>To update an existing item, simply select it from the list. From the detail view, you can:</p>
<ul>
<li>Tap <strong>Add</strong> to increase the quantity</li>
<li>Tap <strong>Remove</strong> to decrease it (e.g., for usage or disposal)</li>
</ul>
<p>To delete an item, either:</p>
<ul>
<li>Tap the <strong>Edit</strong> button in the list view to reveal delete options, or</li>
<li>Swipe the item to the left and tap <strong>Delete</strong> — this uses standard iOS swipe-to-delete behavior</li>
</ul>
<p>Each of these actions automatically creates a transaction history entry, so your usage is always tracked in the background.</p>
<p>All changes are saved automatically — there’s no need to press a Save button.</p>
<p>When adding or removing stock in common increments, you may use the built-in fraction picker to quickly select standard ounce-based amounts like 1/8, 1/4, or 1 oz. WeedTracker will automatically convert these to grams.</p>
<p class="caption headline">Fraction Picker</p>
<div style="text-align: center;">
<a href="images/add_stock_fractions_menu.png" target="_blank">
<img src="images/add_stock_fractions_menu.png"
alt="Fraction picker for common ounce amounts"
class="doc-image"">
</a>
</div>
<p class="caption">Use this menu to quickly add or remove common increments like 1/8, 1/4, or 1 ounce.</p>
<p class="caption headline">List Edit Mode</p>
<div style="text-align: center;">
<a href="images/List_Edit_mode.png" target="_blank">
<img src="images/List_Edit_mode.png"
alt="List view showing Edit mode with delete controls"
class="doc-image"">
</a>
</div>
<p class="caption">
Tapping the Edit button reveals delete controls for each item. You can also swipe an item to delete it using standard iOS gestures.
</p>
<hr>
<!-- END ADDING AND MANAGING INVENTORY -->
<!-- BEGIN Searching and Filtering -->
<h3 id="search-filter">Searching and Sorting</h3>
<p>WeedTracker includes flexible filtering and sorting tools to help you quickly find what you need. These tools work consistently across the app, though the available filter options vary depending on the view.</p>
<p>You can filter your data by a variety of fields — such as name, quantity, type, tier, cost, or rating — depending on the context. For numeric fields like quantity and cost, you can choose a comparison (greater than, less than, equal to) to help narrow results. For tier and type fields, you can select multiple values using the “Add” button.</p>
<p>You can also enter freeform text to search by name or notes, and filter by date range (in the View History and Export History views).</p>
<p>Once filters are applied, only matching results will be shown. You’ll also see a compact summary of the filters currently in effect. You can temporarily hide or show the filtered list using a toggle, or clear all filters at once to reset the view.</p>
<p>Sorting lets you reorder the results by name. You can toggle ascending or descending order with a tap.</p>
<p>These tools are available in the following places:</p>
<ul>
<li><strong>Inventory view</strong> – filter and sort your current items</li>
<li><strong>View History</strong> – filter and sort past transactions</li>
<li><strong>Export History</strong> – filter and sort which transactions to export</li>
<li><strong>Export Inventory</strong> – always exports your full inventory; filtering and sorting are not applicable</li>
</ul>
<p class="caption headline">Inventory Filters Panel</p>
<img src="images/inventory_filters_panel.png" alt="Inventory filter panel with sort and filter options" style="max-width: 300px; width: 100%; height: auto; border: 1px solid #ccc; border-radius: 6px; display: block; margin: 0 auto;">
<p class="caption">Use the filter panel to search, apply filters, or sort inventory items alphabetically by name.</p>
<p class="caption headline">Choose Comparison Operator</p>
<img src="images/choose_comparison_operator_snippet.png" alt="Comparison operator picker with greater than, less than, and equal options" class="doc-image"">
<p class="caption">When filtering by a numeric value such as cost or quantity, tap to choose a comparison operator: greater than, less than, or equal to.</p>
<p class="caption headline">Add Tier Picker</p>
<img src="images/add_tier_popup-snippet.png" alt="Tier picker with custom category options" class="doc-image"">
<p class="caption">Tap the “Add” button to select a tier or type from your defined options. You can add multiple filters in each category.</p>
<hr>
<!-- END Searching and Filtering -->
<!-- BEGIN Viewing Your Usage History -->
<h3 id="logging-usage">Viewing Your Usage History</h3>
<p>To view your usage history, select <strong>View History</strong> from the main menu.</p>
<p>
You can apply all the usual filters — by strain, date range, transaction type, or text match — to narrow down the list of past transactions.
You can also sort the results by date, ascending or descending.
</p>
<p>At the bottom of the list, you'll see a summary of totals based on the <strong>currently filtered record set</strong>. These include:</p>
<ul>
<li><strong>New</strong>: total quantity added by new items</li>
<li><strong>Added</strong>: stock increases to existing items</li>
<li><strong>Removed</strong>: consumption or usage</li>
<li><strong>Deleted</strong>: items removed from inventory</li>
<li><strong>Net Change</strong>: the overall difference in inventory over the selected period</li>
</ul>
<p>For example, you might see that you purchased a total of 30 grams and used 24 grams over a month, resulting in a +6g net change.</p>
<p class="caption headline">View History Screen</p>
<div style="text-align: center;">
<a href="images/view_history.png" target="_blank">
<img src="images/view_history.png"
alt="View History screen with filters and summary totals"
class="doc-image">
</a>
</div>
<p class="caption">The View History screen shows your transaction history with filters, sorting, and a summary of totals at the bottom.</p>
<hr>
<!-- END Viewing Your Usage History -->
<!-- BEGIN Chart -->
<h3 id="chart">Interactive Usage Summary Chart</h3>
<p>To view your usage history chart, select <strong>View Chart</strong> from the main menu.</p>
<p>The Usage Summary Chart provides a quick visual snapshot of your tracked inventory activity over a selected date range.</p>
<ul>
<li><strong>Six Distinct Bars</strong><br>
Displays: New stock added, volume added, volume removed, deleted items, total net increase, and net decrease. Each bar is clearly labeled and color-coded based on common color standards.</li>
<li><strong>Live Data Filtering</strong><br>
Apply a date range to narrow the view—only transactions within that interval will be reflected. Use the filter panel (tap the filter icon in the nav bar) to choose start/end dates. Clear the filter to show all history again.</li>
<li><strong>Interactive Value Annotations</strong><br>
Each bar shows its exact quantity value above it in grams for ease of reading.</li>
<li><strong>Actual Date Range Displayed</strong><br>
Under the chart, the app shows the real transaction range (earliest to latest) that the chart reflects, ensuring full transparency about the timeframe covered.</li>
</ul>
<h3>What the Chart Provides</h3>
<p>Quickly see what’s been added, removed, or deleted over time — plus the overall increase/decrease. The chart gives you a high-level view of your inventory activity without needing to dig through individual records.</p>
<p>It’s designed to complement the detailed transaction history table by helping you spot trends and totals at a glance.</p>
<div class="caption headline">Interactive Usage Summary Chart on iPhone</div>
<a href="images/chart-iPhone.png" target="_blank">
<img src="images/chart-iPhone.png"
alt="iPhone chart showing usage summary"
class="doc-image">
</a>
<hr>
<!-- END Chart -->
<!-- BEGIN Customizing Tier Levels and Types -->
<h3 id="customizing">Customizing Tier Levels and Item Types</h3>
<p>
Access this feature from <strong>Menu → Settings → Edit Types</strong> or <strong>Edit Tiers</strong>.
</p>
<p>
You can personalize your inventory categories by adding, removing, or reordering <strong>tiers</strong> and <strong>types</strong> to suit your needs.
</p>
<ul>
<li><strong>Add a new entry:</strong> Type it in the text box and tap <em>Add</em>.</li>
<li><strong>Remove an entry:</strong> Swipe left, or tap <em>Edit</em> to delete or reorder.</li>
<li><strong>Reorder:</strong> Press and drag to change the order — this is reflected in pickers throughout the app.</li>
</ul>
<div class="caption headline">Reordering and Editing Tiers</div>
<a href="images/edit_tiers_drag_to_reposition.png" target="_blank">
<img src="images/edit_tiers_drag_to_reposition.png"
alt="Drag to reorder tiers"
class="doc-image">
</a>
<br/>
<a href="images/edit_tiers_edit_mode.png" target="_blank">
<img src="images/edit_tiers_edit_mode.png"
alt="Edit mode with delete and reorder handles"
class="doc-image">
</a>
<h3>What Happens to Old Entries?</h3>
<p>
If you've already assigned a type or tier to an item and later remove or rename it here, don’t worry — the app keeps track.
</p>
<ul>
<li>It will <strong>automatically include any legacy values</strong> still in use by inventory items, even if they’re no longer in your custom list.</li>
<li>These older values will appear in pickers with an <strong>asterisk ( * )</strong> to indicate they're still in use but not part of the current list.</li>
</ul>
<p>This ensures all your existing records remain visible and usable without any data loss.</p>
<hr>
<!-- END Customizing Tier Levels and Types -->
<!-- BEGIN Exporting and Importing Data -->
<h3 id="export-import">Exporting and Importing Data</h3>
<p>
Access import and export options through the <strong>Menu → Import/Export</strong> section.
</p>
<p>
WeedTracker lets you back up and transfer both your <strong>inventory</strong> and <strong>history</strong> data. You can:
</p>
<ul>
<li><strong>Export data</strong> in either <em>CSV</em> or <em>tabular text</em> format</li>
<li><strong>Export inventory images</strong> by enabling the image switch on the export screen</li>
<li><strong>Import data</strong> from compatible CSV or tabular text files</li>
</ul>
<h3>Where Exported Files Go</h3>
<p>
When exporting, the app creates a <strong>date- and time-stamped folder</strong> inside the <code>WeedTracker</code> folder in your device’s <code>Documents</code> directory.
</p>
<p>This folder contains:</p>
<ul>
<li><strong>Your exported text or CSV file</strong></li>
<li><strong>Inventory images</strong>, if the option was enabled</li>
</ul>
<h3>Filtering Before Export</h3>
<p>
You can apply filters (by date, strain, type, etc.) and sort records before exporting. This is useful if, for example, you only want to export history from a specific date range.
</p>
<h3>Importing Files</h3>
<ul>
<li><strong>Text files</strong> can be imported from anywhere on your device.</li>
<li><strong>Image files</strong> must be located inside the app’s <code>WeedTracker</code> folder, due to Apple’s file access limitations.</li>
</ul>
<p>This allows for complete backup and restore of your inventory and history data.</p>
<p>When importing, you’ll be prompted to select a file using the standard iOS file picker.</p>
<div class="caption headline">Export Inventory Options</div>
<a href="images/export_inventory_snippet.png" target="_blank">
<img src="images/export_inventory_snippet.png"
alt="Export inventory screen showing export format and image options"
class="doc-image">
</a>
<hr>
<!-- END Exporting and Importing Data -->
<!-- BEGIN iCloud Sync and Multi-Device Use -->
<h3 id="icloud-sync">iCloud Sync and Multi-Device Use</h3>
<p>
WeedTracker supports syncing your data securely across multiple iPhones and iPads using <strong>iCloud</strong>. This allows you to:
</p>
<ul>
<li>Keep your inventory and history in sync across all devices</li>
<li>Make updates on one device and see them reflected on another</li>
<li>Seamlessly switch between devices without losing your data</li>
</ul>
<h3>How It Works</h3>
<p>
WeedTracker uses Apple’s <strong>CloudKit</strong> service to store your data in your private iCloud account. Syncing happens automatically in the background when:
</p>
<ul>
<li>iCloud is enabled for the app</li>
<li>All devices are signed in to the same Apple ID</li>
<li>The app is installed and iCloud permissions are granted on each device</li>
</ul>
<h3>How to Enable iCloud Sync on Your Device</h3>
<ol>
<li>Open the <strong>Settings</strong> app on your device.</li>
<li>Tap your <strong>Apple ID</strong> at the top (your name).</li>
<li>Tap <strong>iCloud</strong>.</li>
<li>Scroll down and tap <strong>Show All</strong> under “Apps Using iCloud.”</li>
<li>Ensure <strong>WeedTracker</strong> is turned <strong>on</strong> in the list.</li>
</ol>
<p><em>Tip: Repeat this check on each device where you use WeedTracker.</em></p>
<h3>Notes</h3>
<ul>
<li>WeedTracker does <strong>not</strong> require iCloud Drive — just basic iCloud support for apps.</li>
<li>Make sure you're connected to the internet for sync to occur.</li>
<li>Changes may take a few moments to sync, depending on network and device activity.</li>
</ul>
<hr>
<!-- END iCloud Sync and Multi-Device Use -->
<!-- BEGIN Clearing Your Data -->
<h3 id="clearing-data">Clearing Your Data</h3>
<p>
You can remove sample data — or any data you've entered — at any time.
</p>
<p>
Go to <strong>Menu → Settings → Clear Database</strong> to:
</p>
<ul>
<li>Delete your <strong>Inventory records</strong></li>
<li>Delete your <strong>Transaction history</strong></li>
<li>Or both at once</li>
</ul>
<p><strong>⚠️ This action is permanent and cannot be undone.</strong></p>
<hr>
<!-- END Clearing Your Data -->
<!-- BEGIN App Settings -->
<h3 id="app-settings">App Settings</h3>
<p>
You can customize key app behavior from the <strong>Menu → Settings</strong> screen:
</p>
<ul>
<li>
<strong>Show Images</strong> <em>(On by default)</em><br>
Toggle this on or off to display inventory images in list views. Turning it off results in a cleaner, faster layout — especially useful on smaller screens or for a more text-focused display.
</li>
<li>
<strong>Low Stock Warning</strong> <em>(Off by default)</em><br>
Enable this to highlight inventory items that fall below a custom threshold. You can:
<ul>
<li>Toggle the warning on or off</li>
<li>Set the low-stock threshold (e.g., 3.5 grams)</li>
</ul>
</li>
<li>
<strong>Edit Tiers and Types</strong><br>
Provides quick access to manage your inventory categories:
<ul>
<li>Tap <em>Edit Tiers</em> or <em>Edit Types</em> to add, remove, or reorder labels</li>
<li>These values appear in filter pickers and item detail views</li>
</ul>
</li>
</ul>
<div class="caption headline">App Settings Panel</div>
<a href="images/settings_page.png" target="_blank">
<img src="images/settings_page.png"
alt="WeedTracker app settings panel"
class="doc-image">
</a>
<p><em>All settings take effect immediately and are saved automatically.</em></p>
<hr>
<!-- END App Settings -->
<h3 id="faq">FAQ and Troubleshooting</h3>
<p>[Coming Soon]</p>
<hr>
<center>
<a href="https://apps.apple.com/us/app/weedtracker/id6747688979?itscg=30200&itsct=apps_box_badge&mttnsubad=6747688979" style="display: inline-block;">
<img src="https://toolbox.marketingtools.apple.com/api/v2/badges/download-on-the-app-store/black/en-us?releaseDate=1753660800" alt="Download on the App Store" style="width: 245px; height: 82px; vertical-align: middle; object-fit: contain;" />
</a>
</center>
</main>
<!--
== WeedTracker Reusable Footer ==
Paste this just before </body>
-->
<footer>
<p>Need help? Visit the <a href="docs.html">documentation</a>, <a href="support.html">support page</a>, or read our <a href="privacy.html">privacy policy</a>.</p>
© 2025 CardComm. All rights reserved.
</footer>
</body>
</html>