Skip to content

Score explanation renderer: format DimensionScore.explanation into Markdown/HTML #2

Description

@emtcmca

v1.0 roadmap candidate, and a genuinely good first issue — self-contained, no scoring logic involved.

What: Every dimension already emits an explanation string. This feature adds a renderer that turns a full scorecard into structured Markdown (and optionally HTML) for display in dashboards, logs, or PR-style review UIs.

Sketch:

renderScorecard(scorecard, { format: 'markdown' }) // => string

Constraints:

  • Zero runtime dependencies — string templating only, no markdown/HTML libraries
  • Pure function of the scorecard: same scorecard in, same string out
  • Must include: total, label, recommended action + reason, per-dimension raw/max + explanation, warnings with codes

Start by reading src/types.ts (ConfidenceScorecard) — the renderer only consumes the public type.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions