README.md

Documentation Index

Start Here

• Project README
• Getting Started for Smithers Developers
• Contributing

How To Develop Burns

• Repository Guide
• Desktop Runtime Package Notes
• CLI Runtime Package Notes
• Web App Package Notes

Reference

• Codebase Layout
• Daemon API Reference

Product And Background

• Product Spec (target state)
• Workspace + Runtime Handoff (Next Agent)
• ADR-0001: Desktop Daemon Bootstrap Mode
• ADR-0002: Runtime API URL Contract

Release Operations

• ElectroBun Release Plan
• Release Automation Reference
• Release Runbook (Canary + Stable)
• Release Checklist

Release helper commands:

• scripts/release/create-release-notes.sh generates a release notes draft for canary/stable.
• scripts/release/verify-artifact-integrity.sh produces checksum manifests for collected artifacts.
• bun run smoke:release runs desktop + CLI runtime smoke checks locally.
• Promote release notes highlights into the root CHANGELOG.md before stable publication.