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

615 B

Raw Blame History

Development Guide

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

Scope: Setting up a dev environment, code style, and PR workflow. Root CONTRIBUTING.md remains the canonical entry point and will link here.

Outline

Environment setup (clone, Hermit, bootstrap, hooks)
Repo layout tour
Code style (Rust, TS/biome)
Running checks locally (Justfile)
PR workflow and review expectations
License/CLA pointer

Source material

CONTRIBUTING.md §Setting Up, §Code Style, §Making a Pull Request, §License and CLA
Justfile, lefthook.yml, biome.json

615 B Raw Blame History

Development Guide

Outline

Source material

615 B

Raw Blame History