|
1 | | -# Summary of Changes Made |
2 | | - |
3 | | -## Directory Structure Changes |
4 | | -1. Moved /apps/portal/src/app/engine → /apps/portal/src/app/transactions |
5 | | -2. Moved /apps/playground-web/src/app/engine → /apps/playground-web/src/app/transactions |
6 | | - |
7 | | -## Portal Changes |
8 | | -1. Updated navigation in Header.tsx: /engine → /transactions |
9 | | -2. Updated sidebar files (v2 and v3) to use /transactions paths |
10 | | -3. Updated layout files to show 'Transactions' instead of 'Engine' |
11 | | -4. Updated EngineVersionSelector component to use transaction links |
12 | | -5. Updated main page and DocSearch component references |
13 | | -6. Updated Unreal Engine references to use /transactions |
14 | | - |
15 | | -## Redirect Configuration |
16 | | -1. Added engineToTransactionsRedirects section with comprehensive redirects |
17 | | -2. Updated infrastructureRedirects to use /transactions paths |
18 | | -3. Updated otherRedirects to use /transactions paths |
19 | | -4. Added redirect rules at highest priority for proper URL handling |
20 | | - |
21 | | -## SDK Documentation Updates |
22 | | -1. Updated documentation links in TypeScript SDK files |
23 | | -2. Updated React hook documentation links |
24 | | -3. Updated playground links in portal sidebars |
25 | | - |
26 | | -## Files Modified: |
27 | | -- Portal: Header.tsx, sidebars, layouts, page.tsx, DocSearch.tsx, redirects.mjs |
28 | | -- Playground: navLinks.ts, page components, webhooks documentation link |
29 | | -- SDK: transaction action files, React hooks |
30 | | -- Unreal Engine: sidebar and page updates |
31 | | - |
32 | | -All /engine routes now redirect to /transactions equivalents while maintaining backward compatibility. |
| 1 | +# Portal-Only Engine to Transactions Migration Summary |
| 2 | + |
| 3 | +## Overview |
| 4 | +Renamed `/engine` slugs to `/transactions` in the **portal app only**, with comprehensive redirects for backward compatibility. |
| 5 | + |
| 6 | +## Portal Changes Made |
| 7 | + |
| 8 | +### 1. Directory Structure |
| 9 | +- **Moved**: `/apps/portal/src/app/engine` → `/apps/portal/src/app/transactions` |
| 10 | + |
| 11 | +### 2. Navigation & UI Updates |
| 12 | +- **Header.tsx**: Updated main navigation `/engine` → `/transactions` |
| 13 | +- **Sidebar files** (v2 & v3): All internal links updated to use `/transactions` paths |
| 14 | +- **Layout files**: Updated to display "Transactions" instead of "Engine" |
| 15 | +- **EngineVersionSelector component**: Updated to use transaction routes |
| 16 | +- **Main page**: Updated article card link |
| 17 | +- **DocSearch component**: Updated search handling |
| 18 | + |
| 19 | +### 3. Comprehensive Redirect Configuration |
| 20 | +Added `engineToTransactionsRedirects` in `redirects.mjs`: |
| 21 | +```javascript |
| 22 | +const engineToTransactionsRedirects = { |
| 23 | + "/engine": "/transactions/v3", // Default to latest |
| 24 | + "/engine/v2": "/transactions/v2", |
| 25 | + "/engine/v3": "/transactions/v3", |
| 26 | + "/engine/:path*": "/transactions/:path*" // Catch-all |
| 27 | +}; |
| 28 | +``` |
| 29 | + |
| 30 | +### 4. Cross-Reference Updates (Portal Only) |
| 31 | +- **Unreal Engine references**: Updated to use `/transactions` |
| 32 | +- **Infrastructure redirects**: Updated to point to `/transactions` |
| 33 | +- **Other redirects**: Updated various legacy redirects |
| 34 | + |
| 35 | +## What Was NOT Changed |
| 36 | +- **Dashboard app**: No changes made (still uses `/engine`) |
| 37 | +- **Playground app**: No changes made (still uses `/engine`) |
| 38 | +- **Packages/SDK**: No documentation link changes made |
| 39 | +- **External links**: Only portal-internal links updated |
| 40 | + |
| 41 | +## Result |
| 42 | +- ✅ Portal now uses `/transactions` URLs consistently |
| 43 | +- ✅ All old `/engine` URLs redirect to `/transactions` |
| 44 | +- ✅ Backward compatibility maintained |
| 45 | +- ✅ Other apps remain unchanged as requested |
| 46 | +- ✅ External playground/API links still work correctly |
0 commit comments