Skip to content

Commit 5966e7f

Browse files
committed
refactor: update comment
1 parent 9ab9845 commit 5966e7f

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

packages/__docs__/src/index.tsx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,9 @@ import { InstUISettingsProvider } from '@instructure/emotion'
3131
import '../globals'
3232

3333
// Restore the original URL after a GitHub Pages 404 -> SPA redirect.
34-
// The 404.html (built in deploy.yml) redirects PR preview sub-routes to
35-
// /pr-preview/pr-{N}/?__spa_route=/path, and this code restores the clean URL.
34+
// 404.html (a copy of index.html, made in deploy.yml) rewrites any deep
35+
// link under the deploy base (e.g. /latest/, /v10/, /pr-preview/pr-N/) to
36+
// <PUBLIC_PATH>?__spa_route=/path. This restores the clean URL on load.
3637
const spaRouteParam = new URLSearchParams(window.location.search).get(
3738
'__spa_route'
3839
)

0 commit comments

Comments
 (0)