Why does the format use deterministic serialization?

Deterministic serialization ensures that the same input always results in the same file output by sorting object keys alphabetically and avoiding random IDs, which is crucial for file comparison and version control.

What is the structure of a .boardkit file?

A .boardkit file is a ZIP archive containing two primary files: package.json for metadata and format versioning, and board.json for the actual document content and elements.

How are version migrations handled in Boardkit?

Migrations are handled through specific functions that transform the document structure from one version to another (e.g., v0 to v1), ensuring backward compatibility as new features are added.

What storage implementations are supported?

The format is designed for both Web environments using IndexedDB with debounced autosave and Desktop environments using Tauri for atomic file system writes.

Boardkit File Format

Name: Boardkit File Format
Author: kevinbarfleur

bykevinbarfleur

0•

Database Management

Manages the .boardkit file structure, document serialization, and versioning for board-based applications.

This skill provides Claude with the technical specifications and implementation patterns for the .boardkit file format, a ZIP-based archive used for document persistence. It covers the internal structure of package.json and board.json, deterministic serialization rules, and version migration paths. It is an essential resource for developers working on the Boardkit ecosystem, enabling the AI to assist with building robust import/export systems, handling atomic writes on desktop, and managing IndexedDB transactions on the web.

Key Features

010 GitHub stars

02ZIP-based archive structure specification

03Deterministic serialization for consistent output

04Versioned schema management and migration paths

05Web (IndexedDB) and Desktop (Tauri) storage patterns

06File validation and integrity check requirements

Use Cases

01Developing backward-compatible migrations between board versions

02Building schema-compliant import/export utilities for web platforms

03Implementing atomic write operations for desktop board files

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add kevinbarfleur/boardkit boardkit-file-format

For use in Claude.ai and ChatGPT

Download Skill