ruvnet / ruvnet/RuView

Feature Request: Add a Beginner-Friendly Quick Start Flow Diagram

Open
#951 4 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
Rust
Stars
94.4k
Forks
12.5k
Avg merge
21h 27m
Merged PRs (30d)
43

Description

Problem

RuView contains extensive documentation, ADRs, firmware guides, sensing workflows, and hardware-specific instructions. New users often struggle to understand the recommended setup path and which components are required for their use case.

For example, a user interested in WiFi sensing may not immediately know:

  • Which hardware is supported
  • Which firmware to install
  • Whether a Cognitum Seed is required
  • Which documentation should be followed first
  • How the data flows from ESP32 devices to RuView

Proposed Solution

Add a visual "Quick Start Flow Diagram" to the README and documentation that guides users through the setup process.

Example flow:

Choose Goal

WiFi Sensing / Pose Estimation / Home Automation

Select Hardware

Install Firmware

Configure Seed

Connect Device

View Results in RuView

Use Case

When onboarding new users, a visual workflow would reduce confusion and help them reach a working setup faster without reading multiple ADRs and documentation pages first.

Alternatives Considered

Users can currently navigate the documentation manually, but this requires understanding project terminology and architecture beforehand.

Impact

This would improve onboarding for new contributors and users, reduce repeated setup questions, and make the project more approachable.

Additional Context

Many open questions in the issue tracker appear to be related to setup and hardware selection. A visual entry point could help reduce this friction.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README, ADRs, firmware guides, sensing workflows, and hardware-specific instructions to map the current setup paths and terminology. Create a visual flow covering goals, hardware, firmware, Seed configuration, device connection, and viewing results; done means a newcomer can identify the relevant path without navigating multiple documents first.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.