mirror of https://github.com/block/buzz.git synced 2026-08-18 06:50:31 +02:00

Files

T

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

architecture

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

assets

…

getting-started

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

guides

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

nips

feat(nips,relay,acp): NIP-AM durable encrypted agent turn metrics (kind 44200) (#1441 )

2026-07-06 16:35:10 +00:00

reference

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

spec

Multi-tenant relay: spec + mechanized formal proof (S1–S8) (#1285 )

2026-06-26 11:15:59 -04:00

vision

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

bridge-channel-window.md

GUI read-model overhaul: server-assembled channel windows (Correct™ pagination + relay-signed bounds) (#1500 )

2026-07-04 11:51:58 -04:00

git-on-object-storage.md

…

MCP_DRIVEN_HOOKS.md

fix(agent): make stop-hook rejection budget per-prompt, fix stale hook docs (#1503 )

2026-07-03 09:21:18 -07:00

mesh-llm-local-build.md

build: make mesh-llm opt-in for dev/staging to speed up iteration (#1183 )

2026-06-22 22:11:50 +00:00

multi-tenant-conformance.md

feat: per-community workspace icon set by admins, served via NIP-11 (#1463 )

2026-07-02 11:58:42 -07:00

multi-tenant-relay.md

Multi-tenant Buzz relay: community_id as a server-resolved key (comprehensive rewrite) (#1321 )

2026-06-29 12:39:02 -04:00

README.md

docs: scaffold documentation information architecture (Phase 1)

2026-07-07 11:48:10 -07:00

README.md

Buzz Documentation

Status: skeleton — Phase 1 (structure). Stub pages carry per-page outlines and source-material pointers; content lands in Phase 2.

Getting Started

Architecture

Guides

Reference

CLI Reference
Configuration
Known Limitations
Buzz NIPs Index → nips/
Design Documents Index → loose docs + spec/

Vision

Vision — aspirational direction, not current behavior

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 are being migrated into this tree. In Phase 2 they will be reduced to pointer files once their content has moved; they are untouched in Phase 1.

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.