Skip to main content

Module sketch

Module sketch 

Source
Expand description

Sketch model for Excalidraw diagrams

Implements sketch support for storing and organizing Excalidraw diagrams within workspaces. Sketches can be linked to knowledge articles, decisions, and other assets.

§File Format

Sketches are stored as .sketch.yaml files following the naming convention: {workspace}_{domain}_sketch-{number}.sketch.yaml

§Example

id: 770e8400-e29b-41d4-a716-446655440001
number: 1
title: "Sales Domain Architecture"
sketchType: architecture
status: published
domain: sales
description: "High-level architecture diagram for sales domain"
excalidrawData: '{"type":"excalidraw","version":2,"elements":[...]}'
thumbnailPath: thumbnails/sketch-0001.png
authors:
  - architect@company.com

Structs§

Sketch
Excalidraw Sketch
SketchIndex
Sketch index (sketches.yaml)
SketchIndexEntry
Sketch index entry for the sketches.yaml file

Enums§

SketchStatus
Sketch status
SketchType
Sketch type/category