Repository navigation
chore: rewrite the readme as a front page and refresh the screenshots - #126
Merged
Merged
Conversation
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).
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
f1-prediction-platform-api | 462d461 | Nov 18 2026, 02:07 PM |
Deploying f1-prediction-platform-web with
|
| 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 |
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.
Summary
README becomes a front page (Interis-style); the technical detail it repeated now lives only in the docs it already duplicated.
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
After:
weighted-v3; the new one is v4.preview/total: 686 KB → 668 KB (same filenames, so the images inarchitecture.md/prediction-model.mdupdate too).Merge Danger
Door: two-way
Docs and images only; revert the commit to undo.
Blast Radius: docs
docs/data-sources.mdjoins the/docscontent collection; its frontmatter matches the schema (title,description,order).