From 27233f4e2e46ba70b833a0d8cfd6abb06a8e81c2 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Wed, 1 Jan 2025 17:13:11 +0530 Subject: [PATCH 1/7] Kanban boards on Nostr --- 100.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 100.md diff --git a/100.md b/100.md new file mode 100644 index 00000000..e1cb68fe --- /dev/null +++ b/100.md @@ -0,0 +1,150 @@ +NIP-100 +====== + +Kanban Boards +------------ + +`draft` `optional` + +This NIP defines a protocol for creating and managing Kanban boards on Nostr. + +## Abstract + +This NIP introduces event kinds and conventions for implementing Kanban boards, allowing users to create boards with multiple columns and cards that can be organized and tracked in a visual workflow. + +## Motivation + +Kanban boards are a popular project management tool that enables visual organization of tasks and workflows. Adding native Kanban support to Nostr allows for decentralized project management while maintaining the platform's permissionless and censorship-resistant nature. + +## Specification + +### Board Event + +```javascript +{ +"created_at": 34324234234, // +"kind": 30301, +"content": { +"description" : "Board Description", // can contain markdown too +"columnMapping": 'EXACT' //map the card's status exactly with column name - Extensible to different logics in future +"columns": [ +{ +"id": "col1", +"name": "To Do", +"order": 0 +}, +{ +"id": "col2", +"name": "In Progress", +"order": 1 +}, +{ +"id": "col3", +"name": "Done", +"order": 2 +} +] +}, +"tags": [ +["d", ""], +["title", "Board Name"], +// List of all cards in the board below +["a", "30302::", ""], +["a", "30302::", ""], +["a", "30302::", ""], +], +// other fields... +} +``` + +### Card Event + +```javascript +{ +"created_at": 34324234234, // +"kind": 30302, +"content": { +"status": "To do", // Match exactly with column name +"description": "Card description", //can contain markdown too +"order": 0, // auto-increment new card order in increments of 10 to provide space for rearranging to an extent +"attachments": [ + "https://example.com/file1.png", + "https://example.com/file2.pdf" +] +}, +"tags": [ +["d", ""], +["title", "Card Title"] +], +// other fields... +} +``` + +### Event Kinds + +- 30301: Kanban Board Definition +- 30302: Kanban Card + +### Required Tags + +#### Board Events (kind: 30301) +- `d`: Unique identifier for the board +- `title`: Board name +- `a`: One for each card in the board + +#### Card Events (kind: 30302) +- `d`: Unique identifier for the card +- `title`: Card title + +### Access Control + +1. Only the board creator can: + - Modify board + - Add a card to the board + +2. Only the card creator can: + - Modify cards (including the status) + +3. Any user can: + - View the board and cards + - React, comment, zap on board and cards + +### Client Behavior + +Clients SHOULD: +- Display boards in a visual column layout +- Allow drag-and-drop card movement for authorized users +- Support board sharing via nostr: URI scheme +- Implement proper authorization checks before allowing modifications + +Clients MAY: +- Implement additional features like card labels, due dates, or assignments +- Support board templates +- Provide filtering and search capabilities + +## Security Considerations + +1. Clients MUST verify event signatures and delegation tokens before allowing modifications +2. Relays MAY implement additional spam prevention measures + +## Implementation Notes + +To maintain a consistent board state: + +1. Clients should handle concurrent updates by: + - Using the event timestamp to resolve conflicts + - Maintaining card order within columns + +2. For performance, clients should: + - Cache board and card data locally + - Use efficient subscription filters when requesting updates + +## Client-Relay Communication Example + +```javascript +// Subscribe to the cards of a board +{ +"kinds": [30302], +"#a": ["30302::","30302::",...] +} +``` From aaa74677fa58e054bdf9aaecf1552c23f5f6996e Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Thu, 2 Jan 2025 05:55:33 +0530 Subject: [PATCH 2/7] Update 100.md Fixed indentation based on comments --- 100.md | 100 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 52 insertions(+), 48 deletions(-) diff --git a/100.md b/100.md index e1cb68fe..d4a2897c 100644 --- a/100.md +++ b/100.md @@ -22,38 +22,38 @@ Kanban boards are a popular project management tool that enables visual organiza ```javascript { -"created_at": 34324234234, // -"kind": 30301, -"content": { -"description" : "Board Description", // can contain markdown too -"columnMapping": 'EXACT' //map the card's status exactly with column name - Extensible to different logics in future -"columns": [ -{ -"id": "col1", -"name": "To Do", -"order": 0 -}, -{ -"id": "col2", -"name": "In Progress", -"order": 1 -}, -{ -"id": "col3", -"name": "Done", -"order": 2 -} -] -}, -"tags": [ -["d", ""], -["title", "Board Name"], -// List of all cards in the board below -["a", "30302::", ""], -["a", "30302::", ""], -["a", "30302::", ""], -], -// other fields... + "created_at": 34324234234, // + "kind": 30301, + "content": { + "description" : "Board Description", // can contain markdown too + "columnMapping": 'EXACT' //map the card's status exactly with column name - Extensible to different logics in future + "columns": [ + { + "id": "col1", + "name": "To Do", + "order": 0 + }, + { + "id": "col2", + "name": "In Progress", + "order": 1 + }, + { + "id": "col3", + "name": "Done", + "order": 2 + } + ] + }, + "tags": [ + ["d", ""], + ["title", "Board Name"], + // List of all cards in the board below + ["a", "30302::", ""], + ["a", "30302::", ""], + ["a", "30302::", ""], + ], + // other fields... } ``` @@ -61,22 +61,26 @@ Kanban boards are a popular project management tool that enables visual organiza ```javascript { -"created_at": 34324234234, // -"kind": 30302, -"content": { -"status": "To do", // Match exactly with column name -"description": "Card description", //can contain markdown too -"order": 0, // auto-increment new card order in increments of 10 to provide space for rearranging to an extent -"attachments": [ - "https://example.com/file1.png", - "https://example.com/file2.pdf" -] -}, -"tags": [ -["d", ""], -["title", "Card Title"] -], -// other fields... + "created_at": 34324234234, // + "kind": 30302, + "content": { + "status": "To do", // Match exactly with column name + "description": "Card description", //can contain markdown too + "order": 0, // auto-increment new card order in increments of 10 to provide space for rearranging to an extent + "attachments": [ + "https://example.com/file1.png", + "https://example.com/file2.pdf" + ] + }, + "tags": [ + ["d", ""], + ["title", "Card Title"], + // add assignees using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57 + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% + ], + // other fields... } ``` From a2507ab77b183d6c03f686215dc02c82e60bb5e6 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Sat, 11 Jan 2025 21:49:15 +0530 Subject: [PATCH 3/7] Update 100.md based on review comments --- 100.md | 128 +++++++++++++++++++++++++++++++++++---------------------- 1 file changed, 79 insertions(+), 49 deletions(-) diff --git a/100.md b/100.md index d4a2897c..e3eb9251 100644 --- a/100.md +++ b/100.md @@ -24,66 +24,97 @@ Kanban boards are a popular project management tool that enables visual organiza { "created_at": 34324234234, // "kind": 30301, - "content": { - "description" : "Board Description", // can contain markdown too - "columnMapping": 'EXACT' //map the card's status exactly with column name - Extensible to different logics in future - "columns": [ - { - "id": "col1", - "name": "To Do", - "order": 0 - }, - { - "id": "col2", - "name": "In Progress", - "order": 1 - }, - { - "id": "col3", - "name": "Done", - "order": 2 - } - ] - }, "tags": [ ["d", ""], ["title", "Board Name"], - // List of all cards in the board below - ["a", "30302::", ""], - ["a", "30302::", ""], - ["a", "30302::", ""], - ], + ["description","Board Description"], //can contain markdown too + ["alt","A board to track my work"], //Human-readable plaintext summary to be shown in non-supporting clients - as per NIP-31 + + // List of all columns in the board below in format ["col","col-id","name","order",<>] + // If the last element in the 'col' tag is not defined, it is assumed that column will display those cards (see event below) whose 's' tags EXACTLY the column name + ["col", "col1-id", "To Do", "0"], + ["col", "col2-id", "In Progress", "1"], + ["col", "col3-id", "Done", "2","Done, Completed, Finished"], + + // designate a 'maintainers' list who can add/edit cards in this board + // add maintainers using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57, if 'zap' tags are absent, then only the owner can add/edit cards in the board + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52" ], + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c" ], // other fields... + ] } ``` +In case there are no `zap` tags to designate maintainers, the owner of the board is the only person who can publish cards on the boards. + +Editing of the board event is possible only by the creator of the board. + ### Card Event ```javascript { "created_at": 34324234234, // "kind": 30302, - "content": { - "status": "To do", // Match exactly with column name - "description": "Card description", //can contain markdown too - "order": 0, // auto-increment new card order in increments of 10 to provide space for rearranging to an extent - "attachments": [ - "https://example.com/file1.png", - "https://example.com/file2.pdf" - ] - }, "tags": [ ["d", ""], ["title", "Card Title"], + ["description","Card Description"], //can contain markdown too + ["alt","A card representing a task"], //Human-readable plaintext summary to be shown in non-supporting clients - as per NIP-31 + ["s", "To do"], //status of the card + ["rank","10"], // order of the card in the column - cards may be displayed in the ascending order of rank by default + + // card url attachments with 'u' tags similar to NIP-98 + ["u","https://attachment1"], + ["u","https://attachment2"], + // add assignees using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57 - [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2", "wss://nostr.oxtr.dev", "1" ], // 25% - [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52", "wss://nostr.wine/", "1" ], // 25% - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c", "wss://nos.lol/", "2" ] // 50% + [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2"], + [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], + [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], + + // The list of boards this card will be a part of. + // However, the card will be displayed in a board only when this event's pubkey matches an entry in the board's maintainers list + ["a", "30301::", ""], + ["a", "30301::", ""], ], // other fields... } ``` +When editing a card, the maintainers can copy the card event with the `d` tag intact and publish a new event. + +When a client gets multiple card events with the same `d` tag, it takes the latest one by any maintainer or the creator of the board event as the source of truth. + +### Tracker Card Event + +In case one wants to just track another nostr event (like a tracker card, without modifying the original event), one can designate a tracker card using a `k` tag to denote kind and `e` tag to denote the nostr event to be tracked. + +```javascript +{ + "created_at": 34324234234, // + "kind": 30302, + "tags": [ + ["d", ""], + ["k", "1"], //this one tracks a text note + ["e", "", ""] // as per NIP-10 + ], + // other fields as per card event above... +} +``` + +The clients MAY display this tracker card like they display the tracked event, or using the 'alt' tag of the original event if not supported. + +Any `30302` event with a `k` tag will be treated as a tracker card. + +#### Automatic movement of tracker cards + +In case of tracked card, its status is deemed to be the `s` tag value of the event it tracks. + +This allows automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. + +If the tracked event does not have an `s` tag, then tracker card event's `s` tag is the status of the card. + ### Event Kinds - 30301: Kanban Board Definition @@ -94,42 +125,41 @@ Kanban boards are a popular project management tool that enables visual organiza #### Board Events (kind: 30301) - `d`: Unique identifier for the board - `title`: Board name -- `a`: One for each card in the board #### Card Events (kind: 30302) - `d`: Unique identifier for the card - `title`: Card title +- `a`: At least one. This points to the board that this card belongs to ### Access Control 1. Only the board creator can: - Modify board + +2. Only the board maintainers can: - Add a card to the board + - Publish edits to the existing cards (including the status) -2. Only the card creator can: - - Modify cards (including the status) - -3. Any user can: +2. Any user can: - View the board and cards - React, comment, zap on board and cards ### Client Behavior -Clients SHOULD: +Clients MAY: - Display boards in a visual column layout - Allow drag-and-drop card movement for authorized users -- Support board sharing via nostr: URI scheme - Implement proper authorization checks before allowing modifications - -Clients MAY: - Implement additional features like card labels, due dates, or assignments - Support board templates - Provide filtering and search capabilities +- Prioritize to show the maintainer comments on cards ## Security Considerations 1. Clients MUST verify event signatures and delegation tokens before allowing modifications 2. Relays MAY implement additional spam prevention measures +3. Relays MAY choose to retain only a few recent versions of board and card events. ## Implementation Notes @@ -139,7 +169,7 @@ To maintain a consistent board state: - Using the event timestamp to resolve conflicts - Maintaining card order within columns -2. For performance, clients should: +2. For performance, clients can: - Cache board and card data locally - Use efficient subscription filters when requesting updates @@ -149,6 +179,6 @@ To maintain a consistent board state: // Subscribe to the cards of a board { "kinds": [30302], -"#a": ["30302::","30302::",...] +"#a": ["30301::",...] } ``` From bcec00cf411eed6f218ef923f3c68c92d92d7175 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Sun, 12 Jan 2025 08:33:22 +0530 Subject: [PATCH 4/7] remove 'zap --- 100.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/100.md b/100.md index e3eb9251..2f3bdf87 100644 --- a/100.md +++ b/100.md @@ -36,19 +36,18 @@ Kanban boards are a popular project management tool that enables visual organiza ["col", "col2-id", "In Progress", "1"], ["col", "col3-id", "Done", "2","Done, Completed, Finished"], - // designate a 'maintainers' list who can add/edit cards in this board - // add maintainers using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57, if 'zap' tags are absent, then only the owner can add/edit cards in the board - [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], - [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52" ], - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c" ], + // Clients may designate a 'maintainers' list who can add/edit cards in this board + [ "p", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], + [ "p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52" ], + [ "p", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c" ], // other fields... ] } ``` -In case there are no `zap` tags to designate maintainers, the owner of the board is the only person who can publish cards on the boards. +In case there are no `p` tags to designate maintainers, the owner of the board is the only person who can publish cards on the boards. -Editing of the board event is possible only by the creator of the board. +Editing the board event is possible only by the creator of the board. ### Card Event @@ -68,13 +67,13 @@ Editing of the board event is possible only by the creator of the board. ["u","https://attachment1"], ["u","https://attachment2"], - // add assignees using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57 - [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2"], - [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], + // add assignees using 'p' tag + [ "p", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2"], + [ "p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], + [ "p", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], // The list of boards this card will be a part of. - // However, the card will be displayed in a board only when this event's pubkey matches an entry in the board's maintainers list + // However, the card will be displayed on a board only when this event's pubkey matches an entry in the board's maintainers list ["a", "30301::", ""], ["a", "30301::", ""], ], @@ -98,8 +97,8 @@ In case one wants to just track another nostr event (like a tracker card, withou ["d", ""], ["k", "1"], //this one tracks a text note ["e", "", ""] // as per NIP-10 + // other fields as per card event above... ], - // other fields as per card event above... } ``` @@ -111,7 +110,7 @@ Any `30302` event with a `k` tag will be treated as a tracker card. In case of tracked card, its status is deemed to be the `s` tag value of the event it tracks. -This allows automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. +This allows the automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. If the tracked event does not have an `s` tag, then tracker card event's `s` tag is the status of the card. From d520ebcbc59544718adb7962ef63058af919dc21 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Sun, 12 Jan 2025 08:33:22 +0530 Subject: [PATCH 5/7] use 'p' tags instead of 'zap' tags for assignees --- 100.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/100.md b/100.md index e3eb9251..2f3bdf87 100644 --- a/100.md +++ b/100.md @@ -36,19 +36,18 @@ Kanban boards are a popular project management tool that enables visual organiza ["col", "col2-id", "In Progress", "1"], ["col", "col3-id", "Done", "2","Done, Completed, Finished"], - // designate a 'maintainers' list who can add/edit cards in this board - // add maintainers using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57, if 'zap' tags are absent, then only the owner can add/edit cards in the board - [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], - [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52" ], - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c" ], + // Clients may designate a 'maintainers' list who can add/edit cards in this board + [ "p", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], + [ "p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52" ], + [ "p", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c" ], // other fields... ] } ``` -In case there are no `zap` tags to designate maintainers, the owner of the board is the only person who can publish cards on the boards. +In case there are no `p` tags to designate maintainers, the owner of the board is the only person who can publish cards on the boards. -Editing of the board event is possible only by the creator of the board. +Editing the board event is possible only by the creator of the board. ### Card Event @@ -68,13 +67,13 @@ Editing of the board event is possible only by the creator of the board. ["u","https://attachment1"], ["u","https://attachment2"], - // add assignees using 'zap' tag so that the zaps go to them using zap-splits as per NIP-57 - [ "zap", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2"], - [ "zap", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], - [ "zap", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], + // add assignees using 'p' tag + [ "p", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2"], + [ "p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], + [ "p", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], // The list of boards this card will be a part of. - // However, the card will be displayed in a board only when this event's pubkey matches an entry in the board's maintainers list + // However, the card will be displayed on a board only when this event's pubkey matches an entry in the board's maintainers list ["a", "30301::", ""], ["a", "30301::", ""], ], @@ -98,8 +97,8 @@ In case one wants to just track another nostr event (like a tracker card, withou ["d", ""], ["k", "1"], //this one tracks a text note ["e", "", ""] // as per NIP-10 + // other fields as per card event above... ], - // other fields as per card event above... } ``` @@ -111,7 +110,7 @@ Any `30302` event with a `k` tag will be treated as a tracker card. In case of tracked card, its status is deemed to be the `s` tag value of the event it tracks. -This allows automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. +This allows the automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. If the tracked event does not have an `s` tag, then tracker card event's `s` tag is the status of the card. From 4775c6b3c3b28e8bbdb7c31bf56ec4ef134e5d67 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Wed, 15 Jan 2025 17:03:59 +0530 Subject: [PATCH 6/7] simplified card tracking --- 100.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/100.md b/100.md index 2f3bdf87..96365136 100644 --- a/100.md +++ b/100.md @@ -30,11 +30,10 @@ Kanban boards are a popular project management tool that enables visual organiza ["description","Board Description"], //can contain markdown too ["alt","A board to track my work"], //Human-readable plaintext summary to be shown in non-supporting clients - as per NIP-31 - // List of all columns in the board below in format ["col","col-id","name","order",<>] - // If the last element in the 'col' tag is not defined, it is assumed that column will display those cards (see event below) whose 's' tags EXACTLY the column name + // List of all columns in the board below in format ["col","col-id","name","order"] ["col", "col1-id", "To Do", "0"], ["col", "col2-id", "In Progress", "1"], - ["col", "col3-id", "Done", "2","Done, Completed, Finished"], + ["col", "col3-id", "Done", "2"], // Clients may designate a 'maintainers' list who can add/edit cards in this board [ "p", "82341f882b6eabcd2ba7f1ef90aad961cf074af15b9ef44a09f9d2a8fbfbe6a2" ], @@ -72,10 +71,9 @@ Editing the board event is possible only by the creator of the board. [ "p", "fa984bd7dbb282f07e16e7ae87b26a2a7b9b90b7246a44771f0cf5ae58018f52"], [ "p", "460c25e682fda7832b52d1f22d3d22b3176d972f60dcdc3212ed8c92ef85065c"], - // The list of boards this card will be a part of. - // However, the card will be displayed on a board only when this event's pubkey matches an entry in the board's maintainers list - ["a", "30301::", ""], - ["a", "30301::", ""], + // The board this card will be a part of. + ["a", "30301::", ""], + ], // other fields... } @@ -94,13 +92,28 @@ In case one wants to just track another nostr event (like a tracker card, withou "created_at": 34324234234, // "kind": 30302, "tags": [ - ["d", ""], + ["d", ""], ["k", "1"], //this one tracks a text note - ["e", "", ""] // as per NIP-10 + ["e", "", ""] // as per NIP-10 // other fields as per card event above... ], } ``` +In case of tracking a replaceable event, one can use `a` tag instead of the `e` tag above. + +In case of tracking another Kanban card (30302) event, one cannot use 'a' tag as that is already used for board association. Hence, we use tags similar to git issues (NIP-34) +```javascript +{ + "created_at": 34324234234, // + "kind": 30302, + "tags": [ + ["d", ""], + ["k", "30302"], //this one tracks a text note + ["refs/board", "30301::"], // very much like git issues + ["refs/card", "" + ], +} +``` The clients MAY display this tracker card like they display the tracked event, or using the 'alt' tag of the original event if not supported. @@ -112,7 +125,7 @@ In case of tracked card, its status is deemed to be the `s` tag value of the eve This allows the automatic movement of a card (like a Git issue) across different columns as the card's status changes in the source system, without any manual updates in the board. -If the tracked event does not have an `s` tag, then tracker card event's `s` tag is the status of the card. +If the tracked event does not have an `s` tag, then tracker card event's `s` tag is shown as the status of the card. ### Event Kinds @@ -128,7 +141,7 @@ If the tracked event does not have an `s` tag, then tracker card event's `s` tag #### Card Events (kind: 30302) - `d`: Unique identifier for the card - `title`: Card title -- `a`: At least one. This points to the board that this card belongs to +- `a`: This points to the board that this card belongs to ### Access Control @@ -178,6 +191,6 @@ To maintain a consistent board state: // Subscribe to the cards of a board { "kinds": [30302], -"#a": ["30301::",...] +"#a": ["30301::"] } ``` From b605bc4ce6d814c412f491731312b586641b7337 Mon Sep 17 00:00:00 2001 From: Vivek Ganesan Date: Sun, 26 Jan 2025 11:17:32 +0530 Subject: [PATCH 7/7] Update 100.md --- 100.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/100.md b/100.md index 96365136..39bba759 100644 --- a/100.md +++ b/100.md @@ -108,7 +108,7 @@ In case of tracking another Kanban card (30302) event, one cannot use 'a' tag as "kind": 30302, "tags": [ ["d", ""], - ["k", "30302"], //this one tracks a text note + ["k", "30302"], //this one tracks another kanban card ["refs/board", "30301::"], // very much like git issues ["refs/card", "" ],