block / block/buzz

Implementation Made Easier for Non-Engineers

Open
#3,583 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Rust
Stars
32.7k
Forks
4.3k
Avg merge
1d 13h
Merged PRs (30d)
253

Description

**Motivation**
Buzz is attracting interest from people in customer success, sales, operations, and other non-technical roles. The current setup documentation assumes familiarity with concepts like workspaces, relays, self-hosting, and building from source, which can make it difficult to know where to start.

**Proposed solution**
Add a short beginner-friendly setup guide that:

* Explains Buzz in plain language
* Helps users choose the right installation path
* Defines terms like workspace, relay, and self-hosting
* Includes screenshots for the main setup steps

**Alternatives considered**
Community guides and videos can help, but official documentation is easier to trust and keep current.

**Additional context**
I’ve seen several non-technical users express interest in Buzz but feel overwhelmed getting started. I ran into the same experience and ended up creating my own install guide. The attached screenshot shows the current onboarding page that prompted this suggestion.

Closest existing issue: None found.

![image](https://github.com/user-attachments/assets/c0a587b2-53d9-4164-bbb2-90f79966167e)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the current setup documentation and the onboarding page shown in the attached screenshot, then map the available installation paths and terms such as workspace, relay, and self-hosting. Done means a short official guide explains Buzz plainly, helps users choose an installation path, defines those terms, and includes screenshots for the main setup steps.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.