Skip to content

[roadmap] First-install runbook: empty devices.json init flow #5

Description

@markminnoye

Problem

A fresh install of the open gateway starts with an empty devices.json. The exact step-by-step from 'container is up' to 'all my devices are claimed and have metadata' is not yet documented. The in-progress auto-discovery design covers the gateway side, but the user-facing sequence is unclear: does the user need to enable a temporary active scan? how long to wait? what does the companion show? what does 'unconfigured' look like?

Why deferred

The runbook depends on the auto-discovery design landing. Writing it before the design is committed would produce documentation that contradicts the eventual implementation.

Trigger to start

Start as soon as the auto-discovery design (to be committed at docs/superpowers/specs/2026-06-04-runtime-auto-discovery-design.md) is merged; write the runbook against the shipped behaviour, not the draft.

Target: one page. Include: a screenshot of the companion 'Unconfigured' view, the exact commands, expected timing per step, and a 'what to do if no devices show up after N hours' troubleshooting section.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions