Enhance README with new sections and add issue templates - #48
Merged
Conversation
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
1 participant
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: Transforms the README from a minimal setup guide into a complete project showcase and adds GitHub issue and pull request templates for contributors. This is the final PR of the roadmap sequence (PRs 19-30).
Changes Included:
README hero: Kept the demo video embed, added a prominent Live Demo link and the full badge row, refreshing the stale Sass and i18next version labels and adding License and Tests badges (160+ tests now accurate after PR 26).
Pitch and features: Added the "What is Useless Polymath?" elevator pitch and feature highlights (24 modules, 3 modes, streak tracking, 4 themes, 3 languages, 90+ code-split chunks, hash routing, responsive sidebar).
Modules table: Rebuilt as the true 7-domain table with per-domain counts from the module registry (24 modules total), fixing the old table's misclassifications (EAN-13, Luhn, Rule of 72 now under Logic; Card Counting under Games).
Architecture: Documented React 19, TypeScript 5.9, Vite 7, SCSS Modules with 4 token-driven themes, i18next HTTP backend, Vitest, GitHub Actions CI/CD, and Biome.
Getting started: Installation, development server, and production build, with the project-standard npm install --ignore-scripts command.
GitHub templates: Added bug report and feature request issue templates and a pull request template with the standard checklist (Biome, tests, build, 3-locale parity, SCSS modules).