Skip to content

Commit fb34e79

Browse files
diegorvclaude
diegorv
and
claude
committed
docs(examples): add missing Portent type definitions and example notes
Context: The type-definitions-features examples only covered 4 of the 8 Portent types (Project, Person, Topic, Meeting). Operation, Responsibility, Task, Event, and Note had no type definitions or example notes. Solution: Added 5 type definitions covering all 8 Portent types grouped by PORT (actionable) and ENTP (non-actionable), plus 5 example notes showing relationships between the new types (Responsibility -> Operation -> Task hierarchy, Event linked to Project, Note as reference material). Behavior: Documentation-only change. Examples now demonstrate the full Portent taxonomy with cross-type relationships via belongs_to/related_to. Files: - help/examples/type-definitions-features/_types/Responsibility.md (new) - help/examples/type-definitions-features/_types/Operation.md (new) - help/examples/type-definitions-features/_types/Task.md (new) - help/examples/type-definitions-features/_types/Event.md (new) - help/examples/type-definitions-features/_types/Note.md (new) - help/examples/type-definitions-features/responsibility-stay-in-shape.md (new) - help/examples/type-definitions-features/operation-strength-training.md (new) - help/examples/type-definitions-features/task-sign-up-playtomic.md (new) - help/examples/type-definitions-features/event-product-launch.md (new) - help/examples/type-definitions-features/note-portent-overview.md (new) - help/examples/type-definitions-features/README.md (lines 16-38, 63) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 93b2c26 commit fb34e79

11 files changed

Lines changed: 207 additions & 6 deletions

‎help/examples/type-definitions-features/README.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,16 @@ sidebar, relationship backlinks, and lifecycle actions in action.
1313

1414
| File | Demonstrates |
1515
|------|--------------|
16-
| **Type definitions** | |
17-
| `_types/Project.md` | Type definition with custom icon, color, order, and template |
18-
| `_types/Person.md` | Type definition with built-in fallback overrides |
19-
| `_types/Topic.md` | Type definition with list properties display |
20-
| `_types/Meeting.md` | Type definition with `_view`, `_title_color`, and date-based sorting |
16+
| **Type definitions (all 8 Portent types + Meeting)** | |
17+
| `_types/Responsibility.md` | PORT: long-running area of accountability |
18+
| `_types/Project.md` | PORT: type definition with custom icon, color, order, and template |
19+
| `_types/Operation.md` | PORT: recurring work with frequency and `belongs_to` display |
20+
| `_types/Task.md` | PORT: one-off work with priority and `belongs_to` display |
21+
| `_types/Event.md` | ENTP: things that happened, date-based sorting |
22+
| `_types/Note.md` | ENTP: default type for knowledge artifacts |
23+
| `_types/Topic.md` | ENTP: type definition with list properties display |
24+
| `_types/Person.md` | ENTP: type definition with built-in fallback overrides |
25+
| `_types/Meeting.md` | Custom type with `_view`, `_title_color`, and date-based sorting |
2126
| **View files** | |
2227
| `active-projects.view` | View with filter expression, custom icon/color, and `_title_color` |
2328
| `recent-meetings.view` | View with date-based filter and `duration()` function |
@@ -29,6 +34,11 @@ sidebar, relationship backlinks, and lifecycle actions in action.
2934
| `person-bob.md` | Person note in inbox (not organized) |
3035
| `topic-rust.md` | Topic note with favorites, `_order`, and multiple backlinks |
3136
| `topic-svelte.md` | Topic note referenced by projects |
37+
| `responsibility-stay-in-shape.md` | Responsibility with metrics and linked operations |
38+
| `operation-strength-training.md` | Operation with `belongs_to` Responsibility and frequency |
39+
| `task-sign-up-playtomic.md` | Task with checklist, `belongs_to` Responsibility |
40+
| `event-product-launch.md` | Event with date, `belongs_to` Project, multiple relationships |
41+
| `note-portent-overview.md` | Note with `belongs_to` and `related_to`, reference material |
3242
| `meeting-kickoff.md` | Untyped note with `belongs_to` relationship |
3343
| `meeting-weekly-standup.md` | Meeting note using `is_a` alias, with `_order` and attendees |
3444

@@ -57,7 +67,7 @@ sidebar, relationship backlinks, and lifecycle actions in action.
5767

5868
1. Copy this folder into your vault.
5969
2. Switch to type sidebar mode (click the grid icon in the file explorer header).
60-
3. Browse Projects, People, Topics, and Meetings sections. Also check "Active Projects" and "Recent Meetings" view entries.
70+
3. Browse all sections: Responsibilities, Projects, Operations, Meetings, Topics, Tasks, Events, Notes, and People. Also check "Active Projects" and "Recent Meetings" view entries.
6171
4. Open `project-kokobrain.md` and check the Backlinks panel for relationship backlinks.
6272
5. Enable Explicit Organization in Settings > Types to see the Inbox filter.
6373

‎help/examples/type-definitions-features/_types/Event.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
type: Type
3+
_icon: calendar
4+
_color: yellow
5+
_order: 6
6+
_sidebar_label: Events
7+
_sort: created
8+
_visible: true
9+
_list_properties_display:
10+
- date
11+
- belongs_to
12+
---
13+
14+
# Event
15+
16+
An event is something that happened and should be retained in long-term memory.
17+
Use for decisions, achievements, incidents, or personal moments.

‎help/examples/type-definitions-features/_types/Note.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
type: Type
3+
_icon: file-text
4+
_color: gray
5+
_order: 8
6+
_sidebar_label: Notes
7+
_sort: modified
8+
_visible: true
9+
_list_properties_display:
10+
- belongs_to
11+
- related_to
12+
---
13+
14+
# Note
15+
16+
A note is a durable knowledge artifact -- documents, references, research summaries,
17+
decision records, or reusable material. The default type for unclassified information.

‎help/examples/type-definitions-features/_types/Operation.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
type: Type
3+
_icon: repeat
4+
_color: purple
5+
_order: 3
6+
_sidebar_label: Operations
7+
_sort: title
8+
_visible: true
9+
_list_properties_display:
10+
- belongs_to
11+
- frequency
12+
---
13+
14+
# Operation
15+
16+
An operation is a recurring piece of work that can be completed in one sitting.
17+
Use for procedures, reviews, checklists, or maintenance routines.

‎help/examples/type-definitions-features/_types/Responsibility.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
type: Type
3+
_icon: target
4+
_color: blue
5+
_order: 0
6+
_sidebar_label: Responsibilities
7+
_sort: title
8+
_visible: true
9+
_list_properties_display:
10+
- status
11+
---
12+
13+
# Responsibility
14+
15+
A responsibility is a long-running area of accountability with metrics or KPIs.
16+
Responsibilities don't have a fixed end date -- they represent standards to maintain.

‎help/examples/type-definitions-features/_types/Task.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
type: Type
3+
_icon: check-square
4+
_color: orange
5+
_order: 5
6+
_sidebar_label: Tasks
7+
_sort: modified
8+
_visible: true
9+
_list_properties_display:
10+
- belongs_to
11+
- priority
12+
---
13+
14+
# Task
15+
16+
A task is a one-off piece of work that can be completed in one sitting.
17+
Tasks can also live in a dedicated tool and link back to projects via relationships.

‎help/examples/type-definitions-features/event-product-launch.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
type: Event
3+
date: 2026-03-15
4+
belongs_to: "[[project-kokobrain]]"
5+
related_to:
6+
- "[[person-alice]]"
7+
- "[[topic-rust]]"
8+
tags:
9+
- milestone
10+
_organized: true
11+
---
12+
13+
# Kokobrain v2.0 Launch
14+
15+
Public release of Kokobrain 2.0 with the type system and semantic search.
16+
17+
## Outcome
18+
- 500+ downloads in the first week
19+
- Positive feedback on the type sidebar UX
20+
- Three bug reports filed (all minor)

‎help/examples/type-definitions-features/note-portent-overview.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
type: Note
3+
related_to:
4+
- "[[topic-rust]]"
5+
- "[[topic-svelte]]"
6+
belongs_to: "[[project-kokobrain]]"
7+
tags:
8+
- reference
9+
- knowledge-management
10+
_organized: true
11+
---
12+
13+
# Portent Overview
14+
15+
Reference note summarizing the Portent specification.
16+
17+
## Core Ideas
18+
- **Types:** PORT (Project, Operation, Responsibility, Task) + ENTP (Event, Note, Topic, Person)
19+
- **Relationships:** `belongs_to` (strong/ownership) and `related_to` (loose/association)
20+
- **Lifecycle:** Capture → Organize → Archive
21+
22+
## Links
23+
- Spec: https://portent.md
24+
- Template vault: https://github.com/refactoringhq/portent-vault-template
25+
- Author: Luca Rossi (https://refactoring.fm)

‎help/examples/type-definitions-features/operation-strength-training.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
type: Operation
3+
frequency: 3x per week
4+
belongs_to: "[[responsibility-stay-in-shape]]"
5+
tags:
6+
- health
7+
- fitness
8+
_organized: true
9+
---
10+
11+
# Strength Training Routine
12+
13+
Recurring workout routine -- a procedure repeated on a regular schedule.
14+
15+
## Routine
16+
1. Warm-up: 10 min mobility
17+
2. Compound lifts: squat, deadlift, bench press (3x5)
18+
3. Accessories: rows, pull-ups, lunges (3x10)
19+
4. Cool-down: 5 min stretching
20+
21+
## Notes
22+
- Track progressive overload in a spreadsheet
23+
- Deload every 4th week

‎help/examples/type-definitions-features/responsibility-stay-in-shape.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
type: Responsibility
3+
status: active
4+
tags:
5+
- health
6+
- personal
7+
_organized: true
8+
_order: 1
9+
---
10+
11+
# Stay in Good Shape
12+
13+
Long-running responsibility to maintain physical health.
14+
15+
## Metrics
16+
- VO2 max above 45
17+
- Train at least 3x per week
18+
- Annual health checkup
19+
20+
## Related Operations
21+
- [[operation-strength-training]]
22+
23+
## Related Projects
24+
- Projects that belong to this responsibility appear in the Backlinks panel

0 commit comments

Comments
 (0)