Add folder descriptions to README with links to DART, LISSY, and data availability visuals#25
Draft
Copilot wants to merge 2 commits intoEEbrami-LISSY-pathfrom
Draft
Conversation
… availability visuals Co-authored-by: EEbrami <148649132+EEbrami@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add folders description to the readme
Add folder descriptions to README with links to DART, LISSY, and data availability visuals
Oct 17, 2025
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.
Overview
This PR updates the main README.md to include a new "Repository Structure" section that provides clear descriptions and navigation links to three key folders in the repository:
Changes Made
Added a new "Repository Structure" section between the "Objectives" and "Methodology" sections that includes:
DART Folder
Link to
./DARTwith a description of the Data Analysis and Reproducibility Toolkit files, including validation scripts, methodological notes, and visualization outputs for analyzing income indicators and generating cross-national poverty metric comparisons.LISSY Folder
Link to
./LISSYwith comprehensive information about the LISSY remote-execution system documentation, highlighting:Data Availability Visuals Folder
Link to
./analysis/data-availability/visualswith a description of the heatmap visualization tools that show which countries have data available for specific time periods, helping researchers identify gaps and opportunities for cross-national analysis.Why This Matters
The new section improves repository navigation and helps users quickly locate important resources. By providing clear descriptions of each folder's purpose, researchers can more easily understand the repository structure and find the tools and documentation they need for their analysis work.
Fixes the documentation gap by making key folders more discoverable and their purposes more explicit.
Original prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.