Enhancements#37
Merged
Merged
Conversation
Add a new ROADMAP.md and industry-standard notes; perform broad documentation updates (README, CHANGELOG, CONTRIBUTING, CODE_OF_CONDUCT, SPONSORSHIP) and small fixes to PR/issue templates. Tidy CSS formatting and hero/styles assets, adjust JS modules and Playwright test/config, update Flutter manifests and app config, and refresh many timing JSON files and other content assets. These changes are primarily editorial, formatting, and documentation additions to clarify roadmap and improve code/style consistency.
Implements a set of offline PWA features and test infrastructure: adds SRS flashcards, streaks/achievements, placement testing, day quiz UI, tone visualizer and a lightweight Hanzi Writer integration. New pages and scripts added (srs/placement/quiz + js/srs.js, js/streaks.js, js/quiz.js, js/placement-page.js, js/tone-visualizer.js, js/hanzi-writer-lite.js) and integrated into index/day pages. Large CSS additions for dashboard, SRS cards, streaks, tone/stroke UI and various layout tweaks; service worker list and data-portability need to be kept in sync with new assets. Adds Playwright e2e specs and a GitHub Actions workflow (tests) to run npm test, and updates ROADMAP/CHANGELOG to document the work. Note: remember to bump sw cache/version and include new local vendor files in data portability exports to ensure offline behavior.
Introduce shared i18n utilities and standardize language toggling across the app. Adds js/i18n.js and js/lang-switcher.js, updates sw.js precache, and wires i18n into page scripts (e.g. day.html). Localized dynamic UI strings and controls across many pages and scripts (quiz, placement, reading, writing, supplementary, review, srs, character-drawing, etc.), and added CSS for modals and quiz day selector (styles.css + styles.min.css cleanup). Also includes an implementation plan doc (docs/plans/...), an end-to-end localization test, and other small HTML tweaks (font preload, noscript fallbacks) to reduce English-only flashes and ensure consistent language behavior.
Add an SRS button to reading vocab items that calls upsertSrsCard and shows a notification, and include js/srs.js in reading.html. Update formatAndDisplayReadingContent to accept level/topic and pass those through for SRS IDs. Apply small formatting/line-wrap cleanups across multiple JS files (i18n, day/supplementary/character-drawing/writing/lang-switcher) and fix some HTML span line-breaks in index.html. Adjust e2e tests formatting and add smoke tests for pinyin tone glyph rendering and the writing stroke-order panel. No dependency lock files changed.
Introduce normalizePreferredLanguage and use it across i18n, lang-switcher, and script to ensure consistent handling of 'zh' vs 'zh-CN'. Update document lang management, language button activation, and selectedLanguage initialization; adjust progress UI to render both zh/en variants when present. Add a Playwright localization test to verify URL-driven language and localStorage behavior. Also remove the obsolete ROADMAP.md.
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.
This pull request introduces a new continuous integration (CI) workflow using Playwright for automated testing, updates documentation across several files for improved clarity and completeness, and makes minor formatting and accessibility improvements to the main lesson page and project templates. The most significant changes are grouped below.
Continuous Integration and Testing:
.github/workflows/test.yml) to run Playwright-based tests on pull requests and pushes tomain, setting up Python, Node.js, installing dependencies, and running tests automatically.Documentation Enhancements:
README.mdwith more detailed technical skills, project features, course structure, setup instructions, and best practices, including clearer usage guides and updated formatting for improved readability. [1] [2] [3] [4] [5] [6] [7] [8] [9]CHANGELOG.mdto document new PWA features, including offline SRS flashcards, streaks, achievements, placement testing, day quizzes, pinyin tone visuals, offline stroke-order playback, progress portability keys, static cache updates, and Playwright test coverage. [1] [2]CONTRIBUTING.md,CODE_OF_CONDUCT.md, andSPONSORSHIP.mdwith additional guidelines, clearer formatting, and more detailed sponsorship tier descriptions. [1] [2] [3]Accessibility and Template Improvements:
day.htmlfile for better HTML5 compliance, improved meta tags, optimized stylesheet loading for performance, and enhanced accessibility with clearer structure and fallback options for users without JavaScript.