jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-11-02 23:41:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: scaffold documentation information architecture (Phase 1)

Browse Source 
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>
This commit is contained in:
npub19zza5yyr075j4vvlg2drsh2xe0xy3dqxhfchlgtw8vryglrry3gq8q7tzk
2026-07-07 11:48:10 -07:00
parent 75079c87ff
commit cfd16deb77
32 changed files with 595 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/guides/adding-api-endpoints.md Normal file
View File

@@ -0,0 +1,17 @@
# Adding a New API Endpoint
> **Status: stub — Phase 1 (structure).** Content to be written in Phase 2.
>
> **Scope:** Step-by-step recipe for adding an HTTP/RPC endpoint to the relay.
## Outline
- Routing and handler placement
- Auth requirements
- Persistence and errors
- Tests
## Source material
- `CONTRIBUTING.md` §How to Add a New API Endpoint
- `crates/buzz-relay/src/api/`