Roveflow docs

The Atlas is built from one file: roveflow-out/journeys.json. It lists every screen and the journeys that connect them. Edit it to rename screens, fix captions, or reorder the flows, then rebuild.

The file

{
  "app": "Acme",
  "platform": "ios",
  "subtitle": "tagline",
  "screens": {
    "home": { "title": "Home", "caption": "short note" }
  },
  "journeys": [
    {
      "category": "Onboarding",
      "title": "Sign up",
      "description": "...",
      "flow": ["home", "signup", "done"]
    }
  ]
}

screens, each key is a screen id. Give it a title and a short caption.
journeys, each one has a category, a title, a description, and a flow: the list of screen ids a user moves through, in order.

The one rule

Every id in a journey’s flow must:

Be a key in screens, and
Have a captured image at roveflow-out/screens/<id>.png.

If an id is missing either, that step won’t show up in the Atlas.

Rename a screen

Change its title or caption under screens. The id stays the same, so your journeys keep working.

"home": { "title": "Dashboard", "caption": "where users land after login" }

Add a journey

Pick a category, write a title and description, and list the screen ids in order.

{
  "category": "Tracking",
  "title": "Log a workout",
  "description": "How a user records activity",
  "flow": ["home", "track", "summary"]
}

Rebuild

After any edit, rebuild the Atlas so your changes show up.

roveflow atlas

Getting started

Desktop app

Command line (CLI)

Concepts

Guides

Reference

Journeys and screens

The file

The one rule

Rename a screen

Add a journey

Categories

Rebuild

​The file

​The one rule

​Rename a screen

​Add a journey

​Categories

​Rebuild

The file

The one rule

Rename a screen

Add a journey

Categories

Rebuild