Skip to content

Remove Remix from docs#3192

Open
alexisintech wants to merge 9 commits intomainfrom
aa/cut-remix
Open

Remove Remix from docs#3192
alexisintech wants to merge 9 commits intomainfrom
aa/cut-remix

Conversation

@alexisintech
Copy link
Member

@alexisintech alexisintech commented Mar 6, 2026

What does this solve? What changed?

The Remix SDK has been in maintenance mode, as Remix is a no longer supported framework and defers to React Router.
This PR serves to remove Remix from the docs, and adds redirects to point users to /docs/core-2 for any Remix needs.

Deadline

  • No rush

Related

⚠️ ORDER OF HOW THINGS SHOULD BE MERGED ⚠️

  1. clerk/clerk-docs initial PR: Remove clear references to Remix.
  2. clerk/clerk PR: Docs - Remove remix, migrate to react router has been reverted https://github.com/clerk/clerk/pull/2245
  3. This PR.
  4. Dashboard PR: Remove Remix onboarding guide & api keys dropdown item

Slack conversation: https://clerkinc.slack.com/archives/C01QFRQNHSN/p1772829651962499

@alexisintech alexisintech requested a review from a team as a code owner March 6, 2026 21:06
@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-docs Ready Ready Preview Mar 12, 2026 6:35pm

Request Review

@alexisintech
Copy link
Member Author

should we just add a dynamic redirect?

{
    "source": "/docs/remix/:path*",
    "destination": "/docs/core-2/remix/:path*",
    "permanent": true,
 }

@alexisintech
Copy link
Member Author

alexisintech commented Mar 6, 2026

ahh, it's throwing errors because it thinks the destination paths don't exist 🤔 we can probably update that logic to check if the destination path includes core-*, to not throw the error @NWylynko

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexisintech Not sure if we should remove from the schema too?

Image

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i left it because i wanted nick to weigh in!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes feel free to remove it from here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And would be good to remove from scripts/lib/schemas.ts too

@SarahSoutoul SarahSoutoul self-assigned this Mar 9, 2026
Comment on lines +3673 to +3685
},
{
"source": "/docs/reference/remix/root-auth-loader",
"destination": "/docs/core-2/remix/reference/remix/root-auth-loader"
},
{
"source": "/docs/reference/remix/overview",
"destination": "/docs/core-2/remix/reference/remix/overview"
},
{
"source": "/docs/reference/remix/clerk-app",
"destination": "/docs/core-2/remix/reference/remix/clerk-app"
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alexisintech These can be replaced with a dynamic redirect potentially:

{
    "source": "/docs/reference/remix/:path*",
    "destination": "/docs/core-2/reference/remix/:path*",
    "permanent": true,
  }

Copy link
Contributor

@SarahSoutoul SarahSoutoul Mar 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whether we make it a dynamic or static redirect, I don't think the destination should have "remix" twice?

E.g: "destination": "/docs/core-2/remix/reference/remix/root-auth-loader" should be "destination": "/docs/core-2/reference/remix/root-auth-loader".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whether we make it a dynamic or static redirect, I don't think the destination should have "remix" twice?

E.g: "destination": "/docs/core-2/remix/reference/remix/root-auth-loader" should be "destination": "/docs/core-2/reference/remix/root-auth-loader".

oh yeah can fix those ones

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer we used static redirects over dynamic, but thats mainly cuz I want to simplify the redirects to only being static, getting rid of dynamic redirects all together.

@SarahSoutoul
Copy link
Contributor

@alexisintech Have reviewed & left some comments! There is sth weird happening w/ some of the redirects for sure - especially with the "clerk-app" page. For some reason, even tho the destination says reference/remix, it leads to remix/reference which is a 404. When I change it back to reference/remix in the URL manually, it leads me to the correct page.

Screen.Recording.2026-03-09.at.11.03.12.am.mov

Other than this, we'll have to make sure to have a sibling clerk PR to remove "Remix" from the SDK dropdown and a dashboard PR to remove the Remix onboarding guide. Happy to help with this if needed.

@alexisintech
Copy link
Member Author

alexisintech commented Mar 9, 2026

okay just fixed all the redirects and tested them and they're working - the only one not working is /docs/guides/development/spa-mode it's not redirecting, its just 404'ing (bc the doc is removed)

@alexisintech
Copy link
Member Author

@alexisintech Have reviewed & left some comments! There is sth weird happening w/ some of the redirects for sure - especially with the "clerk-app" page. For some reason, even tho the destination says reference/remix, it leads to remix/reference which is a 404. When I change it back to reference/remix in the URL manually, it leads me to the correct page.

Screen.Recording.2026-03-09.at.11.03.12.am.mov
Other than this, we'll have to make sure to have a sibling clerk PR to remove "Remix" from the SDK dropdown and a dashboard PR to remove the Remix onboarding guide. Happy to help with this if needed.

@NWylynko if we remove it from clerk/clerk, will that affect core-1 and core-2 branches? if that's the case, we can probably get those to run off a specific branch of clerk/clerk 👀

@SarahSoutoul
Copy link
Contributor

okay just fixed all the redirects and tested them and they're working - the only one not working is /docs/guides/development/spa-mode it's not redirecting, its just 404'ing (bc the doc is removed)

Hmm weird, it's working locally. But yeah not on the preview link? @NWylynko @alexisintech

Screen.Recording.2026-03-09.at.11.43.28.am.mov

Seems like we need to update the tests too to remove Remix from the failing "Test build".

@NWylynko
Copy link
Contributor

NWylynko commented Mar 9, 2026

@alexisintech Have reviewed & left some comments! There is sth weird happening w/ some of the redirects for sure - especially with the "clerk-app" page. For some reason, even tho the destination says reference/remix, it leads to remix/reference which is a 404. When I change it back to reference/remix in the URL manually, it leads me to the correct page.
Screen.Recording.2026-03-09.at.11.03.12.am.mov
Other than this, we'll have to make sure to have a sibling clerk PR to remove "Remix" from the SDK dropdown and a dashboard PR to remove the Remix onboarding guide. Happy to help with this if needed.

@NWylynko if we remove it from clerk/clerk, will that affect core-1 and core-2 branches? if that's the case, we can probably get those to run off a specific branch of clerk/clerk 👀

I think we will want to start with creating a clerk/clerk pr that removes remix from the available sdks and adds to the migration map "remix": "react-router" to migrate users over. This should also then hide all the remix content from the docs. Once thats live then we can merge this pr to solidify the removal of the remix content from the docs.

https://github.com/clerk/clerk/pull/2217 should be good

@alexisintech
Copy link
Member Author

okay just fixed all the redirects and tested them and they're working - the only one not working is /docs/guides/development/spa-mode it's not redirecting, its just 404'ing (bc the doc is removed)

Hmm weird, it's working locally. But yeah not on the preview link? @NWylynko @alexisintech

Screen.Recording.2026-03-09.at.11.43.28.am.mov
Seems like we need to update the tests too to remove Remix from the failing "Test build".

oh it wasn't even working locally for me LOL

@SarahSoutoul
Copy link
Contributor

SarahSoutoul commented Mar 9, 2026

oh it wasn't even working locally for me LOL

Tbh, the redirects don't seem to work for me on the previews. This might be an issue with the preview link itself potentially because locally, it works..

Screen.Recording.2026-03-09.at.11.58.31.am.mov

@alexisintech
Copy link
Member Author

alexisintech commented Mar 9, 2026

@NWylynko could you help with the tests? I'm confused on why it's failing - i simply switched remix for expo?
and looking at this test in the code, i can't figure out what's wrong

Screenshot 2026-03-09 at 11 09 43

@SarahSoutoul
Copy link
Contributor

@NWylynko could you help with the tests? I'm confused on why it's failing - i simply switched remix for expo? and looking at this test in the code, i can't figure out what's wrong - it looks correct to me

All fixed here: Fix tests. Was mostly due to places where "remix" was replaced with "react" rather than "expo", but also the output needing fixing.

@alexisintech
Copy link
Member Author

marking as blocked until https://github.com/clerk/clerk/pull/2217 is merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants