docs/www: update docusaurus to v3 #5719

misterioss · 2024-05-13T10:26:18Z

Closes #5217

🎯 Changes

This PR upgrades docusaurus from v2 to v3

✅ Checklist

I have followed the steps listed in the Contributing guide.
If necessary, I have added documentation related to the changes made.
I have added or updated the tests related to the changes made.

# Conflicts: # pnpm-lock.yaml

# Conflicts: # pnpm-lock.yaml # www/package.json

vercel · 2024-05-13T10:26:24Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
www	❌ Failed (Inspect)			May 15, 2024 4:36pm

vercel · 2024-05-13T10:26:25Z

@misterioss is attempting to deploy a commit to the trpc Team on Vercel.

A member of the Team first needs to authorize it.

autofix-ci · 2024-05-13T10:30:30Z

Hi! I'm autofix.ci, a bot that automatically fixes trivial issues such as code formatting in pull requests.

I would like to apply some automated changes to this pull request, but it looks like I don't have the necessary permissions to do so. To get this pull request into a mergeable state, please do one of the following two things:

Allow edits by maintainers for your pull request, and then re-trigger CI (for example by pushing a new commit).
Manually fix the issues identified for your pull request (see the GitHub Actions output for details on what I would like to change).

juliusmarminge · 2024-05-14T21:17:59Z

Can you fix linting 🙏

KATT

Thanks so much for this!

Please make the branch editable 🙏

KATT · 2024-05-14T21:35:02Z

www/docusaurus.config.js

  title: 'tRPC',
  tagline: 'Move Fast and Break Nothing.\nEnd-to-end typesafe APIs made easy.',
  url: 'https://trpc.io',
  baseUrl: '/',
-  onBrokenLinks: 'throw',
+  onBrokenLinks: 'ignore',


Suggested change

onBrokenLinks: 'ignore',

onBrokenLinks: 'throw',

KATT · 2024-05-14T21:35:13Z

www/docusaurus.config.js

@@ -22,13 +20,12 @@ const poweredByVercel = `
  </div>
 `.trim();

-/** @type {import('@docusaurus/types').Config} */


Can we get types back in?

KATT · 2024-05-14T21:36:43Z

www/docusaurus.config.js

-
-const { parseEnv } = require('./src/utils/env');
-const { generateTypedocDocusaurusPlugins } = require('./docusaurus.typedoc.js');
+// import type { Config } from '@docusaurus/types';


Please get the // @ts-check back in

Suggested change

// import type { Config } from '@docusaurus/types';

// @ts-check

KATT · 2024-05-14T21:38:46Z

www/docusaurus.preferredTheme.js

+      makeElementVisible(LIGHT_THEME_SELECTOR);
+      makeElementInvisible(DARK_THEME_SELECTOR);
+    }
+  }


Could you please explain how come this is needed?

KATT · 2024-05-14T21:39:07Z

www/docusaurus.typedoc.js

-/**
- * @param {string[]} directories
- */


KATT · 2024-05-14T21:39:12Z

www/docusaurus.typedoc.js

@@ -1,11 +1,6 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-// @ts-check


Retain please

KATT · 2024-05-14T21:40:13Z

www/mdx-to-jsx.js

How come this is needed? Could it be type-checked with a // @ts-check?

KATT · 2024-05-15T08:28:08Z

Another question, @misterioss, are you able to do ...

# in root
p install
p build
# switch to `www` and start dev server
cd www && p dev

.. on this branch?

It might be some pre-existing issues that got surfaced by this (since our typedoc is kinda whack even now)

# Conflicts: # www/package.json

misterioss · 2024-05-15T16:37:19Z

Thanks so much for this!

Please make the branch editable 🙏

Strange, I don's see the checkbox for it...

juliusmarminge · 2024-05-22T16:05:20Z

Our custom theme handled diff languague type which the default didnt handle before. Has that been fixed? I saw you reverted to the default one. Deployment fails so cant verify 🤨

KATT

Hey

There's still a bunch of issues with typedoc - do you think they are fixable?

We should probably do

pnpm add typedoc@latest typedoc-plugin-markdown@latest docusaurus-plugin-typedoc@latest --save-dev

in www/

KATT · 2024-05-26T11:34:28Z

www/docusaurus.config.js

@@ -25,7 +25,7 @@ const config = {
  tagline: 'Move Fast and Break Nothing.\nEnd-to-end typesafe APIs made easy.',
  url: 'https://trpc.io',
  baseUrl: '/',
-  onBrokenLinks: 'ignore',
+  onBrokenLinks: 'throw',


I'm guessing you disable this due to typedoc causing it to throw?

misterioss added 20 commits April 12, 2024 12:45

Use @docusaurus/tsconfig instead of old @tsconfig/docusaurus

305f38a

Upgrade docusaurus (a lot of errors for now)

4ea86c3

Make sidebars typescript

537c6d1

Bump @mdx-js/react

daae720

Use remark-shiki-twoslash instead of docusaurus-preset-shiki-twoslash

9e42de1

Fix some md issues

4d829c4

Update docusaurus config

17cde65

Fix some md issues

1f4eee7

Fix more md issues

a05d2f2

Fix some md issues

2db4011

Update docusaurus.typedoc.ts

c9ac8e2

Update config

6bce3ec

Merge branch 'refs/heads/next' into bump/docusaurus

7d48253

# Conflicts: # pnpm-lock.yaml

+/- working version

cb616e7

+/- working version

1a17abd

Merge branch 'refs/heads/next' into bump/docusaurus

fb261ea

# Conflicts: # pnpm-lock.yaml # www/package.json

Merge issues

c74f2e8

Clean up

5c1a9ed

Clean up

7d2e7fb

Clean up

87e678d

misterioss requested review from a team as code owners May 13, 2024 10:26

vercel bot deployed to Preview – todomvc May 13, 2024 10:27 View deployment

vercel bot deployed to Preview – trpc-next-app-dir May 13, 2024 10:28 View deployment

vercel bot deployed to Preview – www May 13, 2024 10:31 View deployment

KATT reviewed May 14, 2024

View reviewed changes

onBrokenLinks: 'throw'

1a808ab

vercel bot deployed to Preview – trpc-next-app-dir May 15, 2024 15:54 View deployment

vercel bot deployed to Preview – todomvc May 15, 2024 15:54 View deployment

vercel bot had a problem deploying to Preview – www May 15, 2024 15:58 Failure

Return back ts-check

874a4fd

vercel bot deployed to Preview – trpc-next-app-dir May 15, 2024 16:04 View deployment

vercel bot deployed to Preview – todomvc May 15, 2024 16:04 View deployment

vercel bot had a problem deploying to Preview – www May 15, 2024 16:08 Failure

Return back previous code style

409dc7a

vercel bot deployed to Preview – todomvc May 15, 2024 16:12 View deployment

vercel bot deployed to Preview – trpc-next-app-dir May 15, 2024 16:12 View deployment

Merge branch 'refs/heads/next' into bump/docusaurus

a5b98f2

# Conflicts: # www/package.json

vercel bot had a problem deploying to Preview – www May 15, 2024 16:16 Failure

Fix mdx

76c588d

vercel bot deployed to Preview – todomvc May 15, 2024 16:29 View deployment

vercel bot deployed to Preview – trpc-next-app-dir May 15, 2024 16:30 View deployment

vercel bot had a problem deploying to Preview – www May 15, 2024 16:36 Failure

KATT requested a review from a team May 20, 2024 21:30

KATT reviewed May 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs/www: update docusaurus to v3 #5719

docs/www: update docusaurus to v3 #5719

misterioss commented May 13, 2024

vercel bot commented May 13, 2024 •

edited

vercel bot commented May 13, 2024

autofix-ci bot commented May 13, 2024

juliusmarminge commented May 14, 2024

KATT left a comment •

edited

KATT May 14, 2024

KATT May 14, 2024

KATT May 14, 2024

KATT May 14, 2024

KATT May 14, 2024

KATT May 14, 2024

KATT May 14, 2024

KATT commented May 15, 2024

misterioss commented May 15, 2024

juliusmarminge commented May 22, 2024

KATT left a comment

KATT May 26, 2024

	// import type { Config } from '@docusaurus/types';
	// @ts-check

		@@ -1,11 +1,6 @@
		/* eslint-disable @typescript-eslint/no-var-requires */
		// @ts-check

docs/www: update docusaurus to v3 #5719

Are you sure you want to change the base?

docs/www: update docusaurus to v3 #5719

Conversation

misterioss commented May 13, 2024

🎯 Changes

✅ Checklist

vercel bot commented May 13, 2024 • edited

vercel bot commented May 13, 2024

autofix-ci bot commented May 13, 2024

juliusmarminge commented May 14, 2024

KATT left a comment • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KATT commented May 15, 2024

misterioss commented May 15, 2024

juliusmarminge commented May 22, 2024

KATT left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vercel bot commented May 13, 2024 •

edited

KATT left a comment •

edited