Update docs template #552
Open
Update docs template #552
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
🧪 E2E Test Results❌ Some tests failed Summary
❌ Failed Tests▲ Vercel Production (14 failed)astro (1 failed):
example (1 failed):
express (2 failed):
fastify (1 failed):
hono (1 failed):
nextjs-turbopack (1 failed):
nextjs-webpack (2 failed):
nitro (1 failed):
nuxt (2 failed):
sveltekit (1 failed):
vite (1 failed):
🌍 Community Worlds (21 failed)mongodb (1 failed):
redis (1 failed):
starter (18 failed):
turso (1 failed):
Details by Category❌ ▲ Vercel Production
✅ 💻 Local Development
✅ 📦 Local Production
✅ 🐘 Local Postgres
✅ 🪟 Windows
❌ 🌍 Community Worlds
❌ Some E2E test jobs failed:
Check the workflow run for details. |
Contributor
📊 Benchmark Results
workflow with no steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro workflow with 1 step💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express workflow with 10 sequential steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro Promise.all with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Next.js (Turbopack) | Nitro Promise.all with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Next.js (Turbopack) | Express Promise.race with 10 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Next.js (Turbopack) | Express | Nitro Promise.race with 25 concurrent steps💻 Local Development
▲ Production (Vercel)
🔍 Observability: Nitro | Express | Next.js (Turbopack) Stream Benchmarks (includes TTFB metrics)workflow with stream💻 Local Development
▲ Production (Vercel)
🔍 Observability: Express | Nitro | Next.js (Turbopack) SummaryFastest Framework by WorldWinner determined by most benchmark wins
Fastest World by FrameworkWinner determined by most benchmark wins
Column Definitions
Worlds:
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Additional Suggestion:
The app's URL structure has changed to use language-prefixed routes (/[lang]/docs/), but the redirects in next.config.ts still point to the old non-language-prefixed routes, causing these redirects to fail and return 404 errors.
View Details
📝 Patch Details
diff --git a/docs/next.config.ts b/docs/next.config.ts
index 9f8856f..878306e 100644
--- a/docs/next.config.ts
+++ b/docs/next.config.ts
@@ -49,12 +49,12 @@ const config: NextConfig = {
return [
{
source: '/docs',
- destination: '/docs/getting-started',
+ destination: '/en/docs/getting-started',
permanent: true,
},
{
source: '/err/:slug',
- destination: '/docs/errors/:slug',
+ destination: '/en/docs/errors/:slug',
permanent: true,
},
];
Analysis
Broken redirects in next.config.ts point to non-existent routes
What fails: The redirects in docs/next.config.ts lines 51-52 and 56-58 point to non-language-prefixed routes that don't exist in the application's new language-based routing structure.
How to reproduce:
- Visit
http://localhost:3000/docs- will redirect to/docs/getting-startedwhich returns 404 - Visit
http://localhost:3000/err/serialization-failed- will redirect to/docs/errors/serialization-failedwhich returns 404
Result: Both redirects fail because the app's route structure requires language prefixes (/[lang]/docs/...) but the redirect destinations are missing the language segment.
Expected: The redirects should point to valid language-prefixed routes that exist in the application (e.g., /en/docs/getting-started and /en/docs/errors/:slug).
Root cause: The application migrated to language-based routing (/[lang]/docs/...) with dynamic language segments, but the redirects in next.config.ts were not updated to include the language prefix. Since /docs/... routes no longer exist and /[lang] is a required dynamic segment, the redirect destinations result in 404 errors.
Fix applied: Updated redirect destinations to use the default language 'en' as prefix:
/docs→/en/docs/getting-started/err/:slug→/en/docs/errors/:slug
Signed-off-by: Hayden Bleasel <[email protected]>
| <a {...props} className="font-normal text-primary no-underline" /> | ||
| ), | ||
| a: ({ href, ...props }) => | ||
| href.startsWith('/') ? ( |
Contributor
There was a problem hiding this comment.
Suggested change
| href.startsWith('/') ? ( | |
| typeof href === 'string' && href.startsWith('/') ? ( |
The a component doesn't safely check if href is defined before calling .startsWith(), causing a runtime error when an anchor tag is rendered without an href attribute.
| ): Promise<{ success: boolean }> => { | ||
| const emoji = emotions.find((e) => e.name === feedback.emotion)?.emoji; | ||
| const body = `${emoji} ${feedback.message}\n\n> Forwarded from user feedback.`; | ||
| const endpoint = new URL('/feedback', 'https://geistdocs.com/feedback'); |
Contributor
There was a problem hiding this comment.
Suggested change
| const endpoint = new URL('/feedback', 'https://geistdocs.com/feedback'); | |
| const endpoint = new URL('/api/feedback', baseUrl); |
Feedback endpoint is hardcoded to external geistdocs.com service instead of using the application's own baseUrl
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.