---
title: Welcome
description: Entry point for StackSats docs, quick navigation, and recommended learning path.
---

# StackSats Documentation

<div class="hero-block">
  <p class="hero-kicker">Strategy-first Bitcoin DCA toolkit</p>
  <h2>Build, validate, and backtest Bitcoin dollar cost averaging (DCA) strategies with a sealed allocation framework.</h2>
  <p>
    StackSats, developed by Hypertrial, is a Python package for strategy-first Bitcoin dollar cost averaging (DCA) research and execution.
    Learn more at <a href="https://www.stackingsats.org">www.stackingsats.org</a>.
  </p>
</div>

## Choose Your Path

<div class="grid cards" markdown>

-   :material-account-school: __I'm New to StackSats__

    ---

    Start with install, first run, and expected outputs.

    [Quickstart](start/quickstart.md)

-   :material-code-braces: __I'm Building a Strategy__

    ---

    Build custom hooks and run validate/backtest/export.

    [First Strategy Run](start/first-strategy-run.md)

-   :material-code-json: __I Need Minimal Code Templates__

    ---

    Copy minimal strategy examples for both supported hook styles.

    [Minimal Strategy Examples](start/minimal-strategy-examples.md)

-   :material-console: __I Need Commands Fast__

    ---

    Use copy-paste lifecycle commands and troubleshooting patterns.

    [CLI Commands](commands.md)

-   :material-format-list-checks: __I Want Task-Based Guidance__

    ---

    Jump directly to common workflows.

    [Task Hub](tasks.md)

-   :material-progress-wrench: __I'm Upgrading Versions__

    ---

    Apply breaking-change mappings quickly.

    [Migration Guide](migration.md)

-   :material-help-circle: __I Have Questions__

    ---

    Read frequently asked questions sourced from docs feedback.

    [FAQ](faq.md)

-   :material-shield-check: __I Need Contract Details__

    ---

    Understand framework-owned invariants and user-owned hooks.

    [Framework Boundary](framework.md)

</div>

## Most Common Tasks

1. Validate a strategy: [Task Hub - validate](tasks.md#i-want-to-validate-a-strategy)
2. Run backtest and inspect artifacts: [Task Hub - backtest](tasks.md#i-want-to-run-a-full-backtest)
3. Export weights safely: [Task Hub - export](tasks.md#i-want-to-export-strategy-weights)
4. Migrate old integration code: [Migration Guide](migration.md)
5. Find answers quickly: [FAQ](faq.md)

## What StackSats Gives You

- Deterministic, invariant-enforced allocation behavior.
- Clear separation between strategy intent and framework mechanics.
- Reproducible lifecycle workflows for validate, backtest, and export.

## Recommended Reading Path

1. [Quickstart](start/quickstart.md)
2. [Task Hub](tasks.md)
3. [First Strategy Run](start/first-strategy-run.md)
4. [Framework Boundary](framework.md)
5. [CLI Commands](commands.md)
6. [Migration Guide](migration.md)
7. [FAQ](faq.md)

## Feedback

- [Was this page helpful? Open docs feedback issue](https://github.com/hypertrial/stacksats/issues/new?template=docs_feedback.md&title=%5Bdocs%5D+Feedback%3A+Docs+Home)
