What's wrong
The Architecture Overview section in the README still shows the old
pre-migration filenames. The entire codebase was migrated to TypeScript,
but the docs weren't updated to match.
Specific outdated references
| README says |
Actual file |
main.jsx |
main.tsx |
ConfigForm.jsx |
ConfigForm.tsx |
TestRunner.jsx |
TestRunner.tsx |
ResultsPanel.jsx |
ResultsPanel.tsx |
ValidationService.js |
ValidationService.ts |
ApiClient.js |
ApiClient.ts |
Why it matters
New contributors reading the README to understand the project structure
will look for files that don't exist under those names. Small thing,
but it creates unnecessary confusion for anyone onboarding.
Fix
Update all file extension references in the Architecture Overview
section of README.md from .jsx/.js to .tsx/.ts where applicable.
Happy to submit a PR for this if it looks good to the maintainers.
What's wrong
The Architecture Overview section in the README still shows the old
pre-migration filenames. The entire codebase was migrated to TypeScript,
but the docs weren't updated to match.
Specific outdated references
main.jsxmain.tsxConfigForm.jsxConfigForm.tsxTestRunner.jsxTestRunner.tsxResultsPanel.jsxResultsPanel.tsxValidationService.jsValidationService.tsApiClient.jsApiClient.tsWhy it matters
New contributors reading the README to understand the project structure
will look for files that don't exist under those names. Small thing,
but it creates unnecessary confusion for anyone onboarding.
Fix
Update all file extension references in the Architecture Overview
section of README.md from
.jsx/.jsto.tsx/.tswhere applicable.Happy to submit a PR for this if it looks good to the maintainers.