Working With AI
AI exchange package reference
Understand the JSON package used to exchange editable project context between Skafold and AI tools.
Every exchange file uses:
{
"format": "skafold-context",
"version": "1.0",
"project": {},
"pages": []
}
Top-level fields
generator: AI provider, model, skill version, and generation time.project: project name, summary, goals, audiences, constraints, and delivery notes.pages: site routes or application screens and their page sections.journeys: focused actor-led paths for meaningful multi-step goals.globalSections: shared headers, footers, navigation, or repeated page sections.architecture: implementation items and direct relationships.design: visual direction, palette, typography, imagery, and system guidance.assumptions: interpretations requiring confirmation.openQuestions: unresolved decisions that materially affect the project.
IDs and references
Use stable lowercase kebab-case IDs.
- Page
parentIdvalues must reference another page. - Journey step
pageIdvalues must reference a declared page. - Architecture relationships must reference declared architecture items.
- Section
globalSectionIdvalues must reference a declared global section. - IDs must be unique within their collection.
Preserve existing IDs when revising an exported package.
Page hierarchy
Use parentId only for the primary structural parent. Do not connect every page that can navigate to another page. Detailed task flows belong in separate journeys.
[
{ "id": "home", "name": "Home", "path": "/" },
{ "id": "blog", "name": "Blog", "parentId": "home" },
{ "id": "blog-post", "name": "Blog Post", "parentId": "blog" }
]
Design data
Design fields are semantic and import into native Skafold design nodes. Colors must use six-digit hexadecimal values such as #1E1B18.
Omit unsupported or unknown values rather than inventing guidance.