Skip to content

Docs: consolidate safety + clamping into docs/safety.md - #8

Merged
frahlg merged 1 commit into
masterfrom
docs/safety
Apr 15, 2026
Merged

frahlg merged 1 commit into
masterfrom
docs/safety

Conversation

@frahlg

@frahlg frahlg commented Apr 15, 2026

Copy link
Copy Markdown
Member

Summary

  • New `docs/safety.md` consolidates the seven-clamp catalogue from `docs/clamping.md` together with the newly-landed safety mechanisms (watchdog-driven autonomous revert, site-meter-stale short-circuit, PV twin input/output sanity envelopes, dispatch min interval).
  • Ten sections: layered defenses, watchdog, fuse guard, min dispatch interval, PI anti-windup + slew rate, battery cascade saturation curves, PV twin envelopes, default-mode implementations, failure-mode catalogue, things-you-should-never-bypass.
  • `docs/clamping.md` becomes a one-line redirect so existing links from README.md / CLAUDE.md keep working.

All file:line references were verified against the current tree. No code changes.

Test plan

  • `cd go && go build ./...` — clean
  • `cd go && go test -timeout 120s -count=1 ./...` — all packages green
  • Internal links resolve (site-convention.md, ../go/... code refs)

Merges docs/clamping.md into a single safety guide covering all four
defense layers (watchdog, dispatch clamps, model sanity envelopes,
driver default mode). Documents the newly-landed watchdog (telemetry
staleness → autonomous revert) and the PV twin input/output envelopes
alongside the existing clamps. docs/clamping.md becomes a one-line
redirect so existing links keep working.
@frahlg
frahlg merged commit 7482a52 into master Apr 15, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 2.0.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant