Skip to content

SnowOps Documentation

Welcome to the SnowOps documentation site — the home for architecture decisions, conventions, project context, client-facing guides, operational runbooks, and go-to-market collateral.

Looking for the engineering source of truth? Start with CLAUDE.md at the repo root (§4 asset catalog, §11 status semantics) — these docs are the long-form, human- and client-facing layer that sits on top of it.

Where to start

If you're... Go to
New to the project Developer Asset Index to explore the codebase, then Project State
Looking up an asset code (e.g. F1, E0, Y3) Asset Glossary → Asset Catalog
Onboarding a new client Runbooks → Client Onboarding, then the client guides on the sales site
Running manual sign-off testing Runbooks → Sequencing & Sign-Off Order, then Manual Test Runbooks
Responding to an incident Runbooks → Incident Response
Working on sales / GTM collateral The sibling snowops-sales repo → sales.snowops.net
Making an architectural change Architecture & Decisions → ADRs

Sections

Architecture & Decisions

Architecture Decision Records (ADRs) — the long-form why behind expensive-to-reverse technical choices. Paired with the fast-reference decisions log.

Conventions

Repo-wide standards every engagement follows: the GitOps branching model and module versioning & private registry strategy.

Project Context

Extended context for the SnowOps Automation project — the Developer Asset Index, full asset catalog, project state, decisions log, milestones, testing strategy, gap register, and module patterns. Loaded on demand, not all at once — see the context index for what to load when. (Company mission & service packages moved to the sales repo — see below.)

Runbooks

Operational playbooks for delivery, incident response, disaster recovery, and testing:

Sales, GTM & Client Guides — moved

The sales/GTM collateral (positioning, pricing, outreach, proposals, contracts, capabilities decks, reference architectures Y0–Y13/Z0–Z3), the brand & presentation system, and the client-facing handover guides now live in the sibling snowops-sales repo, published separately (and access-gated) at sales.snowops.net. See decision D66 in the decisions log.

Hosting & Deployment

How this documentation site is built with MkDocs Material and deployed to Cloudflare.

Directory map

  • adr/ — Architecture Decision Records. Linked from PRs that introduce architectural change.
  • conventions/ — Repo-wide engineering standards (branching, module versioning).
  • context/ — Extended project context, loaded on demand (see context/README.md).
  • runbooks/incident/ — K1. Compromise, ransomware, data leak, DDoS, vendor breach.
  • runbooks/dr/ — L3. Per-service DR procedures and scenario templates.
  • runbooks/client-onboarding/ — Step-by-step new-client kickoff (paired with B1).
  • runbooks/import/ — F12. Brownfield import library — adopting existing IaC.
  • runbooks/offboarding/ — W4. Client offboarding — hand-back vs. tear-down.
  • runbooks/test/ — X6. Manual test runbooks (the human-gated artifact that lets an asset move from 🟦 to 🟩 per claude.md §11). Template lives in context/09-testing-dod.md §10.2.
  • packages/ — Baseline + Advanced deliverable spec sheets (the artifact shared with prospects).