Conversation
…dd FIFA World Cup intro Agent-Logs-Url: https://github.com/EpiForeSITE/idcup/sessions/4d5d751e-c5bb-4d44-9911-7573bbd7e55b Co-authored-by: gvegayon <893619+gvegayon@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Reorganize repository and update README files
Reorganize repo: promote scenarios/README to root, demote technical details to DETAILS.md
Apr 25, 2026
There was a problem hiding this comment.
Pull request overview
This PR restructures repository documentation so the simulation summary becomes the root landing page (README), while detailed technical/materials move into a separate DETAILS.md.
Changes:
- Promotes the scenario overview (plots + city links) to root
README.mdand alignsREADME.qmdas the render source. - Introduces
DETAILS.mdto hold repository layout, data sources, and model overview previously in the root README. - Moves README-rendered figure assets into
README_files/and updates narrative to clarify results are baseline (not World Cup-effect) scenarios.
Reviewed changes
Copilot reviewed 4 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| scenarios/README.md | Removes the old scenario README from scenarios/ (content promoted to root). |
| README.md | Replaces the technical README with a landing-page style summary + figures + city links. |
| README.qmd | Adds the same landing-page intro and updates plot titles to indicate baseline scenarios. |
| DETAILS.md | Adds technical documentation previously in README (layout, setup, data sources, model overview). |
| README_files/figure-commonmark/plot-1.png | Adds/moves the rendered plot asset referenced by the new root README. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
The root
README.mdwas too technical for a landing page; the simulation summary was buried underscenarios/. This restructures the repo so the simulation results are front-and-center.Changes
README.md(new) — moved fromscenarios/README.md; prepended with project intro (CI badges, 2026 FIFA World Cup context, link toDETAILS.md); city scenario links (scenarios/Atlanta.md, etc.) were already root-relativeREADME.qmd— moved fromscenarios/README.qmd; same intro added so re-rendering stays consistent; alldata/andscenarios/paths already worked from rootREADME_files/— moved fromscenarios/README_files/; image refs inREADME.mdresolve without changesDETAILS.md(new) — renamed from oldREADME.md; stalescenarios/README.mdlink updated to./README.md; back-link toREADME.mdaddedparamters→parameters,Agent's→Agents