Merge pull request #25 from paritytech/chore/rename-to-truapi

Prepare for repo rename: truapi-explorer → truapi

Author: TorstenStueber

README.md

@@ -1,6 +1,8 @@
-# TrUAPI Protocol Explorer
+# TrUAPI
 
-Interactive reference documentation for the TrUAPI (Triangle User-Agent Programming Interface) Protocol, the protocol that mediates all communication between a host application and products running in sandboxes.
+TrUAPI (Triangle User-Agent Programming Interface) Protocol — the protocol that mediates all communication between a host application and products running in sandboxes.
+
+This repository is the single source of truth for the TrUAPI protocol, containing Rust trait definitions, an interactive protocol explorer, and documentation.
 
 The explorer covers two protocol versions:
 
@@ -54,8 +56,8 @@ Setup:
 
 After deployment:
 
-- Webapp: `https://paritytech.github.io/truapi-explorer/`
-- Rust docs: `https://paritytech.github.io/truapi-explorer/rustdoc/truapi_spec/`
+- Webapp: `https://paritytech.github.io/truapi/`
+- Rust docs: `https://paritytech.github.io/truapi/rustdoc/truapi_spec/`
 
 The workflow is defined in `.github/workflows/deploy.yml`.
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "tru-api-explorer",
+  "name": "truapi",
   "private": true,
   "version": "0.0.0",
   "type": "module",

src/main.tsx

@@ -4,25 +4,27 @@ import { BrowserRouter } from 'react-router-dom'
 import './index.css'
 import App from './App.tsx'
 
-// The repo was renamed from `host-api-explorer` to `truapi-explorer`.
-// Rewrite any incoming legacy path so bookmarks to the old URL keep working.
-const LEGACY_BASE = '/host-api-explorer'
-const NEW_BASE = '/truapi-explorer'
-if (
-  window.location.pathname === LEGACY_BASE ||
-  window.location.pathname.startsWith(`${LEGACY_BASE}/`)
-) {
-  const rewritten =
-    NEW_BASE +
-    window.location.pathname.slice(LEGACY_BASE.length) +
-    window.location.search +
-    window.location.hash
-  window.location.replace(rewritten)
+// Rewrite legacy paths so bookmarks keep working after renames.
+const CURRENT_BASE = '/truapi'
+const LEGACY_BASES = ['/host-api-explorer', '/truapi-explorer']
+for (const legacy of LEGACY_BASES) {
+  if (
+    window.location.pathname === legacy ||
+    window.location.pathname.startsWith(`${legacy}/`)
+  ) {
+    const rewritten =
+      CURRENT_BASE +
+      window.location.pathname.slice(legacy.length) +
+      window.location.search +
+      window.location.hash
+    window.location.replace(rewritten)
+    break
+  }
 }
 
 createRoot(document.getElementById('root')!).render(
   <StrictMode>
-    <BrowserRouter basename={NEW_BASE}>
+    <BrowserRouter basename={CURRENT_BASE}>
       <App />
     </BrowserRouter>
   </StrictMode>,

vite.config.ts

@@ -18,6 +18,20 @@ function spa404Plugin(): Plugin {
 }
 
 export default defineConfig({
-  base: '/truapi-explorer/',
+  base: '/truapi/',
   plugins: [react(), tailwindcss(), spa404Plugin()],
+  server: {
+    // Redirect legacy base paths to /truapi/ during development.
+    // In production, the 404.html SPA fallback handles this instead.
+    proxy: {
+      '/truapi-explorer': {
+        target: 'http://localhost:5173',
+        rewrite: (path) => path.replace(/^\/truapi-explorer/, '/truapi'),
+      },
+      '/host-api-explorer': {
+        target: 'http://localhost:5173',
+        rewrite: (path) => path.replace(/^\/host-api-explorer/, '/truapi'),
+      },
+    },
+  },
 })