Quick-Start Documentation

Core conventions for organizing distributed engineering notes with HeyWorkNet.

1. Workspace Configuration

Every workspace reads an optional heyworknet.toml file at the repository root:

[workspace]
name = "engineering-notes"
default_branch = "main"

[checks]
require_frontmatter = true
link_validation = "strict"

2. CLI Sync Reference

Use hwn sync to pull upstream note updates and verify local index integrity:

hwn sync --verify-hashes
hwn status --format json

3. Backup & Export

Generate self-contained archival bundles for long-term storage:

hwn archive --include-attachments --output ./snapshots/notes-2026.tar.zst