mirror of
https://github.com/block/buzz.git
synced 2026-11-06 01:11:33 +00:00
cfd16deb77
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>
18 lines
473 B
Markdown
18 lines
473 B
Markdown
# Running a Local Relay
|
|
|
|
> **Status: stub — Phase 1 (structure).** Content to be written in Phase 2.
|
|
>
|
|
> **Scope:** Full local-relay workflow for development: build, run, smoke-test with the CLI.
|
|
|
|
## Outline
|
|
|
|
- Build and run options (cargo, just recipes)
|
|
- Debug vs release gotchas
|
|
- Smoke-testing with `buzz` CLI (keypair, channel, messages, threads)
|
|
- Troubleshooting
|
|
|
|
## Source material
|
|
|
|
- `TESTING.md` §Live Local Relay, §Troubleshooting
|
|
- `Justfile` relay recipes
|