Skip to content

Commit 2b0d03a

Browse files
rushhiiirushhiii
committed
Update HOW_IT_WORKS.md
1 parent 141331d commit 2b0d03a

3 files changed

Lines changed: 1 addition & 22 deletions

File tree

‎Widgets/Countdown Widget/v2/HOW_IT_WORKS.md‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
This document explains the architecture, data model, and runtime behavior of the v2 widget stack from a developer POV.
44

5-
---
65

76
## 1) Architecture overview
87

@@ -16,7 +15,6 @@ This document explains the architecture, data model, and runtime behavior of the
1615
- **Google Calendar**: native reminders and timezone handling.
1716
- **Scriptable**: fast, local UI for iOS widgets.
1817

19-
---
2018

2119
## 2) Data model (Sheet schema)
2220

@@ -41,7 +39,6 @@ Core columns (used by sync and widget):
4139
- `Exact Local Time` is optional and can be derived.
4240
- `Widget Emoji` auto-fills from Event Type if empty.
4341

44-
---
4542

4643
## 3) Sync engine (Apps Script)
4744

@@ -59,7 +56,6 @@ Core columns (used by sync and widget):
5956
- **Debounce + lock**: avoids duplicate syncs from multiple triggers.
6057
- **Auto emoji**: fills `Widget Emoji` based on `Event Type`.
6158

62-
---
6359

6460
## 4) Timezone & reminders logic
6561

@@ -80,7 +76,6 @@ Core columns (used by sync and widget):
8076
- It derives a local time from the smallest reminder offset.
8177
- Writes the derived time back to the sheet.
8278

83-
---
8479

8580
## 5) Widget data feed
8681

@@ -99,15 +94,13 @@ The widget expects:
9994
- `icon`
10095
- `color` (optional)
10196

102-
---
10397

10498
## 6) Widget rendering
10599

106100
- Sorts events by next upcoming date in the current year.
107101
- Shows 1 / 3 / 6 items based on size.
108102
- Small widget supports optional “age mode.”
109103

110-
---
111104

112105
## 7) Notifications
113106

@@ -116,7 +109,7 @@ The widget expects:
116109

117110
To avoid duplicates, disable alerts in one of the calendars.
118111

119-
---
112+
120113

121114
## 8) Extensibility
122115

@@ -125,7 +118,6 @@ To avoid duplicates, disable alerts in one of the calendars.
125118
- Swap UI layout: modify Scriptable stacks.
126119
- Add fields: update Code.gs + widget parser.
127120

128-
---
129121

130122
## 9) Known tradeoffs
131123

‎Widgets/Countdown Widget/v2/README.md‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ A Scriptable widget powered by a Notion → Google Sheets → Google Calendar pi
3030
- **Developers**: want full automation and timezone-aware reminders
3131
- **Non‑developers**: can edit Notion and let automation handle the rest
3232

33-
---
3433

3534
## Quick start
3635

@@ -107,7 +106,6 @@ In your Scriptable script:
107106
- Choose this script.
108107
- Pick Small, Medium, or Large.
109108

110-
---
111109

112110
## Widget size behavior
113111

@@ -117,7 +115,6 @@ In your Scriptable script:
117115

118116
The widget sorts by next upcoming date and shows countdowns.
119117

120-
---
121118

122119
## Screenshots
123120

@@ -128,7 +125,6 @@ Drop your images in [assets](assets) and update these links:
128125
- ![Large widget](assets/widget-large.png)
129126
- ![Poster / collage](assets/poster.png)
130127

131-
---
132128

133129
## Data flow (overview)
134130

@@ -139,7 +135,6 @@ Notion → Google Sheets → Apps Script → Google Calendar → Scriptable Widg
139135
- Apps Script creates calendar events/reminders and serves JSON
140136
- Scriptable reads JSON and renders the widget
141137

142-
---
143138

144139
## Notion template & dashboard
145140

@@ -150,7 +145,6 @@ Notion → Google Sheets → Apps Script → Google Calendar → Scriptable Widg
150145

151146
![Notion dashboard](assets/notion-dashboard.png)
152147

153-
---
154148

155149
## Troubleshooting
156150

‎Widgets/Countdown Widget/v2/USAGE.md‎

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
This guide explains how to use the system day‑to‑day, including the meaning of each column, reminder formats, and how Notion ↔ Sheets mappings should be set up.
44

5-
---
65

76
## 1) Core columns (Sheet)
87

@@ -51,7 +50,6 @@ These columns must exist in your Google Sheet (tab `Main` by default):
5150
- **Widget Clr**
5251
- Hex color for the widget tile (e.g., `#2980b9`).
5352

54-
---
5553

5654
## 2) Notion property names (mapping)
5755

@@ -71,30 +69,26 @@ When using Addsync, map your Notion properties to the sheet columns like this:
7169

7270
Note: In Notion, the reminders field is called **Reminders**. It should map to **Relative Reminders** in Sheets.
7371

74-
---
7572

7673
## 3) How reminders work
7774

7875
- If the owner timezone differs in offset, a separate reminder series is created in Google Calendar.
7976
- If the timezone offsets are the same, reminders attach directly to the main event.
8077
- Every event also gets a **0‑minute popup reminder** at its start time.
8178

82-
---
8379

8480
## 4) Adding new events
8581

8682
1. Add a new row in Notion (or Sheets).
8783
2. Make sure required fields are filled.
8884
3. The script will create the calendar event and write the ID back into the sheet.
8985

90-
---
9186

9287
## 5) Editing or deleting events
9388

9489
- **Edit**: change any field and the next sync updates the event.
9590
- **Delete**: removing a row deletes both the main event and its reminder series.
9691

97-
---
9892

9993
## 6) Widget fields used
10094

@@ -105,7 +99,6 @@ The widget only reads:
10599
- Widget Emoji
106100
- Widget Clr
107101

108-
---
109102

110103
## 7) Example row
111104

0 commit comments

Comments
 (0)