Quickstart

Install Schema City and open your content model as a city in the Umbraco backoffice.

Requirements

Requirement	Version
Umbraco	17 or 18, tested on 17.6.2 and 18.1.1
.NET	10
Backoffice user	Access to the Settings section

Install

dotnet add package TheBuilder.SchemaCity

Restart the site. The package needs no migration and adds nothing to your schema.

Open the city

Open Settings > Advanced > Schema City. The city opens on a raised view of the whole schema, with a board for each type allowed at root.

Every Document Type editor also gets a Relationships tab. It opens the city focused on that type and its neighbours.

Turn off the Relationships tab

The tab is on by default. To leave it out of the Document Type editor, set RelationshipsTab to false in appsettings.json and restart the site:

{
  "SchemaCity": {
    "RelationshipsTab": false
  }
}

The city under Settings > Advanced stays either way. As with any appsettings value, an environment variable can set it too: SchemaCity__RelationshipsTab=false.

First steps

Find a type

Press ⌘ K or Ctrl K and search by name, alias or property alias.

Look at its neighbourhood

Click its building to open the inspector, then double-click it to focus on the types it connects to.

Check the schema

Open Findings in the header to see what the checks flag across the schema. See Review findings.

Trace a change

Press I with a type selected to see every type a change to it reaches. See Trace the impact of a change.

Press ? for every control, or read Navigate the city.

To look around before you install, try the demo. It runs in the browser with a sample schema and needs no Umbraco install.