Files
OpenNoodl/dev-docs/tasks/phase-1/TASK-001-dependency-updates/CHANGELOG.md
2025-12-06 22:37:54 +01:00

2.8 KiB

TASK-001 Changelog

Track all changes made during this task. Update this file as you work.


[Date] - [Your Name/Handle]

Summary

[To be filled in as work progresses]

Starting Point

  • Based on branch: 12-upgrade-dependencies
  • Previous work by: [previous developer]
  • Previous commits include:
    • Package.json dependency updates
    • "Update rendering to use non-deprecated react-dom calls"

Dependency Fixes

Package: [package-name]

  • Issue: [What was wrong]
  • Fix: [What was changed]
  • File: path/to/package.json

React 19 Migration

File: [filename]

  • Before: ReactDOM.render(<App />, element)
  • After: createRoot(element).render(<App />)
  • Notes: [Any relevant context]

react-instantsearch Migration

File: HelpCenter.tsx

  • Before: import { ... } from 'react-instantsearch-hooks-web'
  • After: import { ... } from 'react-instantsearch'
  • API Changes: [List any API differences encountered]

Build Fixes

Error: [Error message]

  • Cause: [Why it happened]
  • Fix: [What was changed]
  • File: path/to/file

Build Optimizations

Optimization: [Name]

  • Before: Build time X seconds
  • After: Build time Y seconds
  • Change: [What was optimized]

Files Modified

  • package.json (root)
  • packages/noodl-editor/package.json
  • packages/noodl-core-ui/package.json
  • packages/noodl-viewer-react/package.json
  • packages/noodl-editor/src/editor/src/views/HelpCenter/HelpCenter.tsx
  • [Add more as needed]

Files Created

  • None expected for this task

Files Deleted

  • None expected for this task

Breaking Changes

  • React 19 requires Node.js 18+ (documented in root package.json engines)
  • [Add any other breaking changes discovered]

Testing Notes

Automated Tests

  • npm run test:editor: [PASS/FAIL] - [Notes]
  • npm run test:platform: [PASS/FAIL] - [Notes]
  • npx tsc --noEmit: [PASS/FAIL] - [Notes]

Manual Tests

  • Dev server start: [PASS/FAIL]
  • Create project: [PASS/FAIL]
  • Node operations: [PASS/FAIL]
  • Preview: [PASS/FAIL]
  • Help Center search: [PASS/FAIL]
  • Hot reload: [PASS/FAIL]

Known Issues

  1. [Issue description] - [Will be addressed in TASK-XXX]

Follow-up Tasks

  1. [Follow-up item] - Suggested for TASK-XXX

Final Summary

[To be completed when task is done]

Total files modified: X Total lines changed: +X / -Y Build time: Before X sec → After Y sec Tests: All passing / X failures Confidence: X/10