Developer Docs

Developer Docs

Canonical technical documentation for building, packaging, and extending SnapTray without overloading the GitHub README.

This section is the canonical home for SnapTray’s technical documentation. The root README is intentionally product-oriented; the material that used to live there now belongs here.

What lives here

  • Build from Source: prerequisites, scripts, manual CMake flows, cache setup, and local build troubleshooting
  • Release & Packaging: DMG / NSIS / MSIX packaging, signing, notarization, Store submission, and icon asset workflow
  • Architecture Overview: repository structure, library boundaries, architecture patterns, platform-specific code, and development conventions

Audience split

  • GitHub README: product landing page, install/download entry points, and high-level workflow overview
  • /docs/*: end-user tutorials, feature references, troubleshooting, FAQ, and CLI usage
  • /developer/*: contributor and agent-facing technical reference

Source of truth policy

  • Product marketing copy belongs on the README and website homepage.
  • User workflow detail belongs in /docs/*.
  • Build, packaging, architecture, and debug-only integration detail belongs in /developer/*.
  • AGENTS.md stays concise and points back to these pages instead of duplicating long inventories that drift over time.
  1. Build from Source
  2. Architecture Overview
  3. Release & Packaging