Refactor: Separate data from markdown presentation layer#228
Draft
Refactor: Separate data from markdown presentation layer#228
Conversation
- Extract repository data into YAML format (data/repositories.yml) - Create rendering script to generate README from YAML - Add validation script for data quality - Set up GitHub Actions workflow for automated README generation - Add CONTRIBUTING.md with documentation Co-authored-by: amis92 <2671396+amis92@users.noreply.github.com>
Co-authored-by: amis92 <2671396+amis92@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Refactor awesome list style repository structure
Refactor: Separate data from markdown presentation layer
Dec 22, 2025
Kataane
reviewed
Jan 8, 2026
| - 'scripts/render_readme.py' | ||
| workflow_dispatch: | ||
|
|
||
| jobs: |
Contributor
There was a problem hiding this comment.
If you start reworking the repository, what about simplifying the steps for adding new libraries? GitHub allows react when the pull request is merged. We could use that to make users simply create a new PR with a URL to the GitHub repository. Then, we could parse the GitHub repository by the URL and automatically create a new readme.
In summary:
- Create a template for PR
- React to "github.event.pull_request.merged == true".
https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#running-your-pull_request-workflow-when-a-pull-request-merges - Get the URL to the GitHub library from PR.
- Parse the GitHub library.
- Automate updating the README.
If you need help, I can help you write the scripts.
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.
Refactors the awesome-list repository to separate data from presentation, enabling automated validation and README generation.
Changes
Data Layer
data/repositories.yml- Single source of truth containing 231 repositories across 20 categories in YAML formatScripts
scripts/validate_data.py- Validates YAML schema, GitHub URLs, required fields, and detects duplicatesscripts/render_readme.py- Generates README.md from YAML with consistent formattingscripts/extract_data.py- One-time migration helper (extracts from existing README)Automation
.github/workflows/render-readme.yml- GitHub Actions workflow that:Documentation
CONTRIBUTING.md- Guidelines for adding repositories and categoriesTESTING.md- Local development and testing instructionsrequirements.txt- Python dependencies (pyyaml)Benefits
Example Usage
Add a new repository:
Run validation and render:
python scripts/validate_data.py && python scripts/render_readme.pyOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.