Skip to content

Phase 1: pass tooling emits directive blocks instead of spliced tables #31

Description

@mmcky

Part of #28 (Phase 1). Gated on the report theme's Phase 1b exit.

Problem. tools/qestyle_report.py --splice regenerates full tables inside <!-- qe:NAME --> regions in intro.md, details.md, README.md and each series index.md, and tools/qestyle_draft.py writes each lecture report's score breakdown, issues, strengths and actions as markdown (UPDATE.md § Step 5 at a92f911b). Under the report theme the same regions become directives from compliance.mjs that read the CSVs at build time: one line per region instead of a 27-row table, and no way for a table to disagree with its CSV.

Proposed work.

  • qestyle_report.py: each spliced region emits its directive ({qe-triage-table}, {qe-wins} with {qe-win} items, {qe-trend}, {qe-method-stats}, the series {qe-score-strip}, {qe-priority-bar}, {qe-systemic}, {qe-clean-rules}, {qe-ranked-table}) per the theme repo's syntax sheet; README.md's scoreboard keeps a plain table since GitHub renders no directives.
  • qestyle_draft.py: per-lecture reports emit {qe-score-breakdown}, {qe-issues} with {qe-issue} items carrying the authored example text and lines, and plain lists for strengths and actions; the fix-immediately section emits {qe-finding} from findings.csv.
  • The charts.md regions are handled by Phase 1: native charts page — directives replace the matplotlib cells #33; the two hand-written series regions (series-narrative, series-recommendations) stay prose.
  • A --legacy-tables switch keeps the old output until the deploy switches, so both branches can be built from one pass.

Acceptance criteria.

  • A pass on the mystmd branch produces no spliced tables, only directive lines and prose
  • Every number the old tables showed is visible in the built site from the directive output
  • Typed counts in {qe-issue} items match violations.csv and judgment.csv, so the plugin's verification passes under --strict

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

    enhancementImprovement to existing content or functionality

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions