docs: rewrite README plain and sober#8
Merged
Merged
Conversation
Replace the centered HTML banner and shield row with a plain title and a single Tests badge. Fold the motivation into two factual paragraphs, recast the data-source list as a table, remove bold lead-ins and the unverified SHA-256 claim. Remove the monthly-refresh README badge seds, which have no targets left.
There was a problem hiding this comment.
Pull request overview
This PR simplifies the project’s top-level documentation by replacing HTML-heavy README formatting and auto-updated “monthly refresh” badges with plain Markdown, while keeping the monthly refresh workflow focused on committing generated artifacts only.
Changes:
- Rewrites
README.mdto remove the centered HTML banner/badge block and present a plain Markdown introduction with a single Tests badge. - Refactors “Motivation / Getting Started” into more direct “Installation” + “Usage” sections and converts data sources into a Markdown table.
- Removes the monthly-refresh workflow’s README badge rewriting and stops staging README changes in that workflow.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Rewrites the README to be plain Markdown, removes the dynamic badge row, and restructures sections for clearer setup/usage. |
| .github/workflows/monthly-refresh.yml | Removes README badge update logic and limits commits to generated output/ artifacts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| fi | ||
|
|
||
| git add output/ README.md | ||
| git add output/ |
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.
Replaces the centered HTML banner, shield row, and bold tagline with plain markdown and a single Tests badge. Motivation folded into two factual paragraphs; data sources recast as a table; bold lead-ins and the unverified SHA-256 claim removed. The monthly-refresh badge seds are removed along with their targets. No code changes.