Repository navigation
feat(briefing): one command that explains the chart — the window as a markdown briefing - #92
Merged
Merged
Conversation
… markdown briefing wickchart-briefing composes the visible range into a structured markdown document: tape summary (windowSummary), candlestick signal census (detectSignals from wickchart-signals), smart annotations and the narrate timeline with legs (narrateWindow from wickchart-narrator). Pure composition, no re-derivation — the briefing can never disagree with the chart. attachBriefing installs chart.briefing()/copyBriefing() over the visible range; briefingModel() is the pure half (no chart, no DOM). Deterministic output: UTC-stable stamps, injectable clock.
…ion; roadmap strikes the row The hub's 17th package (import map extended for the sibling-plugin specifiers); the demo's Explain panel gains an AI-summary/Briefing tab.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Recommended PR #4 of the first five (ROADMAP v3, Track 1):
wickchart-briefingsynthesizes the visible window into a structured markdown briefing — tape summary, candlestick signal census, smart annotations and the narrate timeline — "explain this chart" as a first-class artifact. S–M effort, pure composition.Design
windowSummary(wickchart/core), the census isdetectSignals(wickchart-signals), the annotations and timeline aredetectAnnotations+narrateWindow(wickchart-narrator). The briefing can never disagree with the chart it describes.attachBriefing(chart)installschart.briefing()(the model:{ title, generatedAt, window, summary, signals, annotations, timeline, markdown }, null before data) andchart.copyBriefing()(clipboard). Visible-range scoped, full-dataset fallback,detach()restores the instance.YYYY-MM-DD HH:MMstamps and an injectablenow— the same window briefs byte-identically (pinned by tests).wickchart-briefing/coreis the pure half — no chart, no DOM.wickchart-signals+wickchart-narrator(declared; the first plugin to compose siblings — the hub's zero-dependency claim is updated honestly). Root devDependencies gain file: links so the bare specifiers resolve in Node tests.Gates
plugins/briefing/tests/briefing.test.mjs): composition identity, markdown shape, determinism, degenerate windows, census grouping, attach/detach contract.