docs: tighten README quick start and stale comments
ci / check (push) Successful in 1m20s
ci / check (pull_request) Successful in 51s

- Lead with purpose and exact local/CI commands.
- Remove local absolute paths, stale auth notes and unverified claims.
- Keep comments to the reason or invariant they protect.
This commit is contained in:
Noel Sabia committed 2026-11-14 09:16:19 +01:00
1 parent dbb7a009a7
commit 66b80a62fb
14 files changed
+82 -84

No files matched your search

+1 -5
View File
@@ -84,11 +84,7 @@ export function hhmm(hour: number): string {
return `${String(hour).padStart(2, '0')}:00`
}
/**
* Mock scenario behaviour. The contract defines the scenario enum but not the
* size of each perturbation; these multipliers are demo assumptions and are
* shown in the UI. The Go/ML implementation must publish the same numbers.
*/
/** Demo perturbations for the mock fallback; the Go API applies scenarios from ML output. */
export function applyScenario(points: Point[], scenario: Scenario): Point[] {
if (scenario === 'base') return points
return points.map((point) => {
+1 -2
View File
@@ -1,5 +1,4 @@
// Canonical shapes from /home/noel/Documents/Hackathon_2026/CONTRACT.md (v1 draft).
// Keep these in sync with the Go API; the UI consumes exactly these fields.
// Canonical wire shapes for the Go API; keep them in sync with the contract.
export const HORIZONS = ['15m', '1h', '48h', '7d'] as const
export type Horizon = (typeof HORIZONS)[number]