Skip to content

README.md

Latest commit

 

History

History
61 lines (42 loc) · 5.17 KB

README.md

File metadata and controls

61 lines (42 loc) · 5.17 KB
Raw

status-translations

Translation-progress dashboard for the QuantEcon lecture series — public data store + GitHub Pages site tracking coverage, freshness, automation and review state for every language edition.

Live dashboard: https://quantecon.github.io/status-translations/

This repo follows the org's status-* pattern (sibling of status-lectures, which tracks build/environment configuration): data lives in-repo as JSON, the dashboard is a static page on GitHub Pages, and no credentials beyond GITHUB_TOKEN are needed — every fact is computed from public GitHub state.

What it answers

Translation health is two-dimensional: coverage (how much of the source series is translated) and freshness (how current those translations are against the moving English source). An edition can be 100% translated and rotting, or 65% and perfectly synced. The dashboard shows, per source series → edition:

  • coverage (lectures translated / total, with per-lecture detail)
  • last sync and upstream drift (source PRs merged since)
  • automation wiring (sync / AI review / rebase workflows)
  • human-review backlog (translation-review issues)
  • a synthesised status (healthy / drifting / stalled / planned), plus the language-expansion pipeline

How it works

  1. collector/collect.py blobless-clones each source repo and its editions, compares lectures/*.md file sets and per-file last-commit dates, checks workflow wiring, and counts sync-era PRs and review issues.
  2. It writes data/latest.json and a dated snapshot in data/history/ — history accumulates from day one, so trend views come free later.
  3. site/index.html (static, no dependencies) fetches data/latest.json and renders the dashboard; the publish workflow deploys site/ + data/ to Pages on every push, and the collect workflow redeploys after committing fresh data.

Editorial facts the collector can't compute (series titles, phase labels, review-campaign notes, the language pipeline) live in collector/config.json. To add a language or series, extend that file.

Layout

data/
  latest.json         # current snapshot (the dashboard reads this)
  history/            # dated snapshots, append-only
site/
  index.html          # the dashboard (static, client-side rendering)
collector/
  collect.py          # computes the numbers (git + gh + python stdlib)
  config.json         # repo pairs + editorial fields
.github/workflows/
  publish.yml         # deploy site + data to Pages on push
  collect.yml         # data collection (manual until verified; then nightly cron)

Counting rule

A "lecture" is a top-level lectures/*.md file in the source repo, excluding README and status (the build-status page). Coverage counts files present in both source and edition; edition-only files are reported as orphans (e.g. pre-rename leftovers). Program docs have historically counted raw .md files including status, so figures here can sit one lower (48/51 vs 49/52) — this repo's rule is the canonical one for reporting.

Status & verification

  • data/latest.json is currently a manually seeded snapshot (2026-07-09), verified against live GitHub state: file lists and set differences via the contents API, review-issue counts and last-sync commit dates via gh.
  • The collector is v1 and unverified: before enabling the cron in collect.yml, run it via Actions → collect → Run workflow (or locally: python3 collector/collect.py) and check the committed diff against the seed — coverage and orphans should reproduce exactly; staleness counts are new information; drift-PR counts are approximate by design (all merged source PRs since last sync, not only lecture-touching ones — the translation-sync-metadata contract will make drift exact per-file).

Placement (provisional)

This repo is the dashboard's current home, not a permanent commitment. How QuantEcon organises project and dashboard reporting is still being worked out (see the reporting-strategy discussions at meta#332 and meta#321); if a central reporting hub emerges (e.g. under QuantEcon/dashboard), this dashboard is designed to relocate cheaply — the static site and the versioned data contract (data/latest.json + data/history/) are self-contained, so moving means moving files and updating one URL.

Related repos

  • action-translation — the translation engine (sync / review / rebase); its sync metadata (#66) is this dashboard's upgrade path for exact drift.
  • project-translation — private program workspace: roadmap, decisions, research; this dashboard replaces its hand-maintained coverage tables as the live status layer.
  • status-lectures — build/environment-configuration dashboard for the same repo family.
  • dashboard — curated presentation hub; links here for translation progress.