-
Notifications
You must be signed in to change notification settings - Fork 29.7k
docs: fix proxy matcher overflow #85337
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: canary
Are you sure you want to change the base?
Conversation
|
Hi there 👋 It looks like this PR introduces broken links to the docs, please take a moment to fix them before merging:
Thank you 🙏 |
| > | ||
| > - In Proxy, you can also read cookies using `req.cookies.get('session').value`. | ||
| > - Proxy uses the [Edge Runtime](/docs/app/api-reference/edge), check if your Auth library and session management library are compatible. | ||
| > - Proxy uses the Node.js runtime, check if your Auth library and session management library are compatible. You may need to use [Middleware](/docs/15/app/api-reference/file-conventions/middleware) if your Auth library only supports [Edge Runtime](/docs/api-reference/edge) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| > - Proxy uses the Node.js runtime, check if your Auth library and session management library are compatible. You may need to use [Middleware](/docs/15/app/api-reference/file-conventions/middleware) if your Auth library only supports [Edge Runtime](/docs/api-reference/edge) | |
| > - Proxy uses the Node.js runtime, check if your Auth library and session management library are compatible. You may need to use [Proxy](/docs/app/api-reference/file-conventions/proxy) if your Auth library only supports [Edge Runtime](/docs/app/api-reference/edge) |
The line contains two broken documentation links: one references a non-existent versioned path with /docs/15/ and the other references deprecated middleware instead of proxy, and it also has an incomplete link to the Edge Runtime documentation.
View Details
Analysis
Broken documentation links in authentication guide
What fails: Line 1124 in docs/01-app/02-guides/authentication.mdx contains two incorrect documentation links:
[Middleware](/docs/15/app/api-reference/file-conventions/middleware)- references non-existent versioned path and deprecated middleware naming[Edge Runtime](/docs/api-reference/edge)- incomplete path missing/appsegment
How to reproduce:
Examine docs/01-app/02-guides/authentication.mdx line 1124
Expected behavior: Links should follow the documentation structure used throughout the codebase:
- Proxy link should be:
/docs/app/api-reference/file-conventions/proxy(14 instances of this correct format found across codebase) - Edge Runtime link should be:
/docs/app/api-reference/edge(7 instances found including line 564 in same file)
What was actually happening:
- Version number
/15/only appears in this one broken link (no versioning pattern used elsewhere) middlewarefile convention is deprecated and renamed toproxyper proxy.mdx documentation- No
middleware.mdxfile exists indocs/01-app/03-api-reference/03-file-conventions/directory
Fix applied:
- Changed
[Middleware](/docs/15/app/api-reference/file-conventions/middleware)to[Proxy](/docs/app/api-reference/file-conventions/proxy) - Changed
[Edge Runtime](/docs/api-reference/edge)to[Edge Runtime](/docs/app/api-reference/edge)
Both links now match the established documentation patterns used consistently throughout the codebase.
Also closes: #85344