Skip to content

Fix dropped range separators in structural drift warning strings + full documentation overhaul#5

Merged
rpwalsh merged 1 commit into
mainfrom
copilot/update-documentation-frameworks
May 7, 2026
Merged

Fix dropped range separators in structural drift warning strings + full documentation overhaul#5
rpwalsh merged 1 commit into
mainfrom
copilot/update-documentation-frameworks

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 7, 2026

UTF-8 BOM encoding stripped en-dashes from two DriftWarning runtime strings, producing nonsense output. Documentation was skeletal framework text that didn't reflect the actual codebase — missing endpoints, entities, equations, and containing hardcoded developer machine paths.

Code fix

structural_drift.py — two DriftWarning.likely_effects strings had their separators silently dropped:

# Before — nonsense runtime output
"forecast confidence degraded for next 1218 hours"
"Forecast error history for the most recent window (e.g. last 612 observations)"

# After
"forecast confidence degraded for next 12–18 hours"
"Forecast error history for the most recent window (e.g. last 6–12 observations)"

Documentation

  • QUICKSTART.md — removed hardcoded c:\Users\react\DispatchLayer / c:/python314/python.exe paths; replaced with make targets as primary method plus portable Linux/macOS and PowerShell alternatives
  • PYTHON_DEEPDIVE.md — same path fix; expanded package topology to include anomaly, simulation, recommendations, and all 5 connector packages; added complete route responsibility map for all 11 route files
  • API.md — expanded from ~15 to 30+ endpoints; adds the full /predictive/* suite, telemetry write endpoints, connector/audit/ingest endpoints with contract notes
  • DOMAIN_MODEL.md — adds ~15 missing entity definitions from models.py and telemetry.py: GeoPoint, ForecastWindow, AssetType, TelemetryPoint, AssetTelemetrySnapshot, TelemetrySample, Quality, GenerationMix, PortfolioSummary, etc.
  • ARCHITECTURE.md — adds connectors layer with fail-soft behavior note; DecisionTrace in observability section; Makefile quick-reference table
  • docs/mathematics/predictive-math-core.md — replaces one-liner stubs with actual equations from code: PVWatts solar derating model, cubic wind power curve, P10/P90 (±1.28σ), forecast reconciliation bias correction, structural drift standardised shift scoring, and L-layer typed temporal decay formula

@rpwalsh rpwalsh marked this pull request as ready for review May 7, 2026 08:17
@rpwalsh rpwalsh merged commit cbde594 into main May 7, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants