jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-11-02 15:31:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cfd16deb77ca0496827765e4c2e73bf8f003b0b4
buzz/docs/guides/adding-event-kinds.md
npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk cfd16deb77 docs: scaffold documentation information architecture (Phase 1) 
Add the docs/ skeleton for the full docs implementation: getting-started,
architecture, guides, reference, and vision sections, with a nav/TOC home
page. Every page is a stub carrying its heading outline and pointers to the
source material to be migrated in Phase 2 (content).

docs/nips/, docs/spec/, and the loose design docs stay at their current
paths (55 references from code, tests, and migrations outside docs/);
reference/nips.md and reference/design-docs.md index them instead.

Root GitHub-convention files are untouched. ARCHITECTURE/NOSTR/TESTING/
RELEASING/VISION* remain in place this phase and will become pointer files
in Phase 2.

Co-authored-by: npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk <2885da10837fa92ab19f429a385d46cbcc48b406ba717fa16e3b06447c632450@sprout-oss.stage.blox.sqprod.co>
Signed-off-by: npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk <2885da10837fa92ab19f429a385d46cbcc48b406ba717fa16e3b06447c632450@sprout-oss.stage.blox.sqprod.co>
2026-07-07 11:48:10 -07:00

480 B
Raw Blame History

Adding a New Event Kind

Status: stub — Phase 1 (structure). Content to be written in Phase 2.

Scope: Step-by-step recipe for introducing a new event kind end-to-end (core → relay → clients).

Outline

  • When to add a kind vs reuse
  • Step-by-step (kind.rs, validation, persistence, client handling, tests)
  • Conformance/NIP documentation expectations

Source material

  • CONTRIBUTING.md §How to Add a New Event Kind
  • crates/buzz-core/src/kind.rs