Skip to content

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

@nayar-900

Description

@nayar-900

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions