Skip to content

Commit 8141a82

Browse files
committed
📜 Docs: expand glossary with new event definitions and clarify existing terms
1 parent 09ab769 commit 8141a82

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

‎docs/learn/glossary.md‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,22 @@
22

33
Definition of terms used in the source code and documentation.
44

5-
**Event**: A calendar event that is already persisted to the database and is not being edited. When a user first views the calendar, the events they see are Events.
5+
## Events
6+
7+
**Standalone Event**: An event that has a datetime and is NOT recurring.
8+
9+
**Grid Event**: An event that is assigned to a specific time slot on the calendar in the grid.
610

711
**Draft Event**: A calendar event that has pending changes that have not yet been persisted to the database. When a user makes changes to an event in the form, or drags the event, or resizing its times, the user is operating on a draft event. After the user clicks "Save", the draft event is persisted to the database, and the Draft Event goes away and is replaced with the Event.
812

13+
**Someday Event**: These have `startDate` and `endDate` like regular timed events, but they have not yet been assigned to a specific time slot on the calendar in the grid. Instead, they are stored in the sidebar. These may be recurring or standalone.
14+
15+
**Base Event**: A _recurring_ event that is recurring and has the series `RRULE` in the `recurrence` field.
16+
17+
**Instance Event**: A _recurring_ event that is an instance of the base event.
18+
19+
## Other
20+
921
**Calendar**: A calendar is a collection of events. It is the main object in the application.
1022

1123
**Calendar List**: AKA sub-calendars. A calendar list is a collection of calendars.
@@ -18,5 +30,4 @@ Definition of terms used in the source code and documentation.
1830
- Month view
1931
- Year view
2032

21-
22-
**Sync**: The Compass feature that allows users to sync their calendar data with other calendars like Google Calendar.
33+
**Sync**: The Compass feature that allows users to sync their calendar data with other calendars like Google Calendar.

0 commit comments

Comments
 (0)