From 02606aa2eaa5d8f34a03ac4c51671202b9052cf6 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 23 Jan 2026 14:13:04 +0000 Subject: [PATCH] docs(ai): update quickstart and contributing (agent) --- CONTRIBUTING.md | 6 ++++++ README.md | 2 +- docs/nostr-event-schemas.md | 2 ++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b0771d9..bf32bf1c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,6 +105,12 @@ To set up the project locally: ``` *Note: Unit tests may take a few minutes to complete.* + You can also run end-to-end and visual tests: + ```bash + npm run test:e2e + npm run test:visual + ``` + 4. **Format & Lint**: ```bash npm run format diff --git a/README.md b/README.md index 276a0ad7..72fe7be6 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ Use these artifacts to inspect the UI state at the moment of failure and diagnos ### Send your first video post -Use the event builders in `js/nostrEventSchemas.js` to construct valid video notes. +Use the event builders in `js/nostrEventSchemas.js` (the source of truth for all event definitions) to construct valid video notes. ```javascript import { buildVideoPostEvent } from "./js/nostrEventSchemas.js"; diff --git a/docs/nostr-event-schemas.md b/docs/nostr-event-schemas.md index 8451aaeb..c38e0909 100644 --- a/docs/nostr-event-schemas.md +++ b/docs/nostr-event-schemas.md @@ -171,6 +171,8 @@ import { updateWatchHistoryListWithDefaultClient } from "./nostrWatchHistoryFaca | Admin whitelist (`NOTE_TYPES.ADMIN_WHITELIST`) | `30000` | `['d', 'bitvid:admin:whitelist']`, repeated `['p', ]` entries | Empty content | | Profile metadata (`NOTE_TYPES.PROFILE_METADATA`) | `0` | `['d', ...]` is not used | JSON payload with NIP-01 fields (`name`, `about`, `picture`, `nip05`, etc.) | | Mute list (`NOTE_TYPES.MUTE_LIST`) | `10000` | Repeated `['p', ]` tags for blocked/muted users | Optional content (often encrypted) | +| Deletion (`NOTE_TYPES.DELETION`) | `5` | `['e', ]` or `['a', ]` | Reason for deletion | +| Legacy Direct Message (`NOTE_TYPES.LEGACY_DM`) | `4` | `['p', ]` | NIP-04 encrypted ciphertext | | Zap request (`NOTE_TYPES.ZAP_REQUEST`) | `9734` | `['p', ]` plus optional `['e', ]`, `['a', ]`, `['amount', ]`, `['lnurl', ]`, and `['relays', ...]` for receipt publishing | Optional plaintext zap note | | Zap receipt (`NOTE_TYPES.ZAP_RECEIPT`) | `9735` | `['bolt11', ]`, `['description', ]`, `['p', ]` plus optional `['e', ]` and `['a', ]` | Empty content; receipts are published by the recipient's LNURL server |