Skip to content

chore: rewrite the readme as a front page and refresh the screenshots - #126

Merged
Glory42 merged 1 commit into
masterfrom
docs/readme-refresh
Nov 18, 2026
Merged

Glory42 merged 1 commit into
masterfrom
docs/readme-refresh

Conversation

@Glory42

@Glory42 Glory42 commented Nov 18, 2026

Copy link
Copy Markdown
Owner

Summary

README becomes a front page (Interis-style); the technical detail it repeated now lives only in the docs it already duplicated.

 README.md
-  Stack · Monorepo layout · Local dev · Tests · ETL jobs · Env vars · Model table · Deployment
+  Header + links + badges · Features · Screenshot grid · How the predictions work
+  Data · Tech stack · 4-line local setup · Layout · Documentation table
 CONTRIBUTING.md            + `bun run dev` ports, links to data-sources / data-pipeline / deployment
 CODEMAP.md                 + docs/data-sources.md row
+docs/data-sources.md       # each source, what each era has, credits (also renders on /docs)
 preview/*.webp             # all 17 re-shot from f1.gorkemkaryol.dev, 1600×1000, WebP q80

Moved, not lost: ETL/backfill commands → data-engine/README.md + docs/data-pipeline.md; env vars + deploy → docs/deployment.md; local snapshot setup → CONTRIBUTING.md; model table → docs/prediction-model.md.

Evidence

  • Before: old home
    After: new home
  • The old prediction-detail shot still showed weighted-v3; the new one is v4.
  • preview/ total: 686 KB → 668 KB (same filenames, so the images in architecture.md / prediction-model.md update too).

Merge Danger

Door: two-way

Docs and images only; revert the commit to undo.

Blast Radius: docs

docs/data-sources.md joins the /docs content collection; its frontmatter matches the schema (title, description, order).

The readme carried setup, ETL, env-var and deployment detail that already
lives in CONTRIBUTING.md, data-engine/README.md and docs/; it now links
there. Adds docs/data-sources.md (sources, coverage by era, credits) and
re-shoots every preview/ image from the live site (the old ones predated
weighted-v4).
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
f1-prediction-platform-api 462d461 Nov 18 2026, 02:07 PM

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying f1-prediction-platform-web with  Cloudflare Pages  Cloudflare Pages

Latest commit: 462d461
Status: ✅  Deploy successful!
Preview URL: https://0a3eb909.f1-prediction-platform-web.pages.dev
Branch Preview URL: https://docs-readme-refresh.f1-prediction-platform-web.pages.dev

View logs

@Glory42
Glory42 merged commit 7f74599 into master Nov 18, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant