Skip to main content

Welcome to UiGraph Documentation

UiGraph helps engineering, product, and platform teams describe how a system works through maps, frames, implementation points, database models, and synced engineering metadata.

This docs site is organized around three practical areas:

  • Platform workflows for maps, frames, and points
  • Data modeling for SQL and NoSQL schema visualization
  • Automation with uigraph-cli for syncing repository metadata into UiGraph

Start here​

If you are evaluating or adopting UiGraph, start with these guides:

  1. Creating and Managing Maps
  2. Managing Frames
  3. Points, Map Points, and Frame Groups
  4. UiGraph CLI

Platform workflows​

Use these guides when documenting product flows and connecting interface regions to implementation details:

Data modeling​

Use these guides when importing and reviewing database structures:

Automation​

Use uigraph-cli when you want repository-driven documentation and CI/CD automation:

Core concepts​

  • A map groups frames around a feature, flow, or domain.
  • A frame represents a screen, diagram, or other visual artifact inside a map.
  • A point links a region of a frame to implementation details, another map, or nested frame variants.
  • Database modeling turns schema files into visual structures your team can inspect in context.
  • uigraph-cli syncs service metadata, API specs, diagrams, tests, and database schemas from a repository-level .uigraph.yaml.

For teams and platform owners​

If you are rolling out UiGraph across multiple services, use this sequence:

  • Start with one service or product area
  • Define a consistent naming model for maps, frames, and linked artifacts
  • Keep schemas, API specs, and Mermaid diagrams in version control
  • Use uigraph-cli in CI to make documentation updates part of delivery

Support​