The unit of work for one architecture model, its specifications, and attachments.
A project is the bounded workspace for one product, system, or domain. All model YAML, specification pages, and attachments for that scope live in a single project under one organization — optionally inside a folder.
In this group
Create Project
New project, GitHub import, clone from branch.
Project Settings
Metadata, members, publish, GitHub integration.
File-based workflow in VS Code or Cursor: Git Project.
Contents
| Area | Description |
|---|---|
| Model | Architecture YAML — objects, links, attributes |
| Specifications | MDX pages in the specs tree |
| Attachments | OpenAPI, ERD, diagrams, and handbooks |
| Members | Users and groups with a project role |
| Branches | Commit history and working copies (cloud only) |
Studio seeds every new cloud project with Specs and Model enabled, default branch main, and welcome spec common/welcome.
Identity fields
Set at creation; editable in Project Settings:
| Field | Example | Constraints |
|---|---|---|
| Name | IoT Gateway | 1–30 characters |
| Key | iot-gateway | 1–20 characters; a-z, digits, -, _, .; unique within folder |
| Icon | — | Optional |
| Description | Edge gateway architecture | Optional, max 500 characters |
The key is generated from the name and appears in project links, published URLs, and automation. Treat it as a stable identifier for bookmarks and pipeline configuration.
Key changes rewrite project URLs immediately. Plan updates to dependents before renaming.
Last updated on