Skip to content

README.md

Latest commit

 

History

History
39 lines (27 loc) · 1.35 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.35 KB
Raw

Stormbox Docs

This directory is the human entry point for project documentation.

Architecture

Architecture overview and index summarizes the system and links to the focused design documents.

Spec-Driven Development

Stormbox uses GitHub Spec Kit for shared, IDE-agnostic specs.

  • Project constitution: project-wide product and architecture constraints.
  • Specs: feature specs created through the Spec Kit workflow.
  • MVP scope spec: the first product-level spec, reframed from the original MVP planning document.

Shared Spec Kit artifacts (.specify/ and specs/) are committed. Local agent bindings, including .cursor/skills/, are per-developer setup and remain ignored.

To install the local Cursor bindings for this repo:

uvx --from git+https://github.com/github/spec-kit.git@v0.4.4 \
  specify init --here --force --ai cursor-agent --ai-skills --offline

Contributors using another supported agent should pass that agent to --ai instead.

Research

Research and benchmarks live outside docs/ because they include executable Playwright configs, specs, and benchmark scripts. Keep research artifacts with their runner files and link to them from docs when they inform architecture or product decisions.