mirror of
https://github.com/block/buzz.git
synced 2026-08-18 06:50:31 +02:00
npub1pejagjwzjh7y36gq97hxf62ry75u3s6c6grr0rumx2p4c5qsms9s7jdtgl
23f75dac90
Fill all 31 stub pages scaffolded in Phase 1 with content migrated and verified from the root docs, crate READMEs, and source code: - getting-started/ (3): installation, quickstart, local relay (TESTING.md) - architecture/ (8): ARCHITECTURE.md §1–§8, one page per section - guides/ (9): development, testing, agents, workflows, self-hosting, nostr-clients (operational half of NOSTR.md), adding-event-kinds, adding-api-endpoints, releasing - reference/ (5): CLI reference verified against buzz --help and crates/buzz-cli/src (18 groups / 87 subcommands; README drift noted), configuration, known-limitations (ARCHITECTURE §9 + conformance LIMITS.md + doc-debt list), NIPs index (13, NIP-CW canonical), design-docs index - vision/ (6): VISION.md + 5 VISION_*.md migrated with aspirational banners and rewritten links Root originals (ARCHITECTURE, NOSTR, TESTING, RELEASING, VISION*) get pointer notes marking docs/ as canonical; deletion is a follow-up. All relative links in the new tree verified to resolve. Known limitations are documented honestly, never papered over: rate limiting unenforced, WF-07/WF-08 workflow stubs, buzz-cli README drift, one-line GOVERNANCE.md. Note: pre-commit sadscan findings reviewed as false positives (dev-default postgres URI and NIP-OA test vectors, both already on origin/main). Co-authored-by: npub1pejagjwzjh7y36gq97hxf62ry75u3s6c6grr0rumx2p4c5qsms9s7jdtgl <0e65d449c295fc48e9002fae64e94327a9c8c358d206378f9b32835c5010dc0b@sprout-oss.stage.blox.sqprod.co> Signed-off-by: npub1pejagjwzjh7y36gq97hxf62ry75u3s6c6grr0rumx2p4c5qsms9s7jdtgl <0e65d449c295fc48e9002fae64e94327a9c8c358d206378f9b32835c5010dc0b@sprout-oss.stage.blox.sqprod.co>
Buzz Documentation
Getting Started
Architecture
- Overview
- Protocol
- Connection Lifecycle
- Event Pipeline
- Subscription System
- Crate Reference
- Security Model
- Infrastructure
Guides
- Development
- Testing
- Working with Agents
- Workflows
- Self-Hosting
- Using Third-Party Nostr Clients
- Adding a New Event Kind
- Adding a New API Endpoint
- Releasing
Reference
- CLI Reference
- Configuration
- Known Limitations
- Buzz NIPs Index →
nips/ - Design Documents Index → loose docs +
spec/
Vision
Aspirational direction — not current behavior (see known limitations for what's real today):
- The relay is the workspace — core vision
- Agent Activity Feed
- buzz-agent + buzz-dev-mcp
- Buzz Mesh — community compute
- Buzz Projects — Nostr-native forge
- Sovereign relay — your project, your domain
Root-Level Docs (stay at repository root)
GitHub-convention files remain at the root: README.md, CONTRIBUTING.md, SECURITY.md,
GOVERNANCE.md, CODE_OF_CONDUCT.md, CHANGELOG.md, AGENTS.md/CLAUDE.md.
ARCHITECTURE.md, NOSTR.md, TESTING.md, RELEASING.md, and VISION*.md have been
migrated into this tree. The originals remain at the root with pointer notes for now;
removing them is a follow-up decision. This tree is canonical for migrated content.
Note on file locations
docs/nips/, docs/spec/, and the loose design docs (docs/*.md) are referenced by
code, tests, and migrations (55 references outside docs/). They stay at their current
paths; the reference/ index pages link to them instead.