-
Notifications
You must be signed in to change notification settings - Fork 84
Finish renaming "embedded" world to "local" in docs #269
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
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Additional Suggestion:
The vercel-world.mdx file contains broken documentation links pointing to the old embedded-world URL, but the file has been renamed to local-world.mdx in this PR. These links need to be updated to prevent broken references in the documentation.
View Details
📝 Patch Details
diff --git a/docs/content/docs/deploying/world/vercel-world.mdx b/docs/content/docs/deploying/world/vercel-world.mdx
index 16a1462..7334a76 100644
--- a/docs/content/docs/deploying/world/vercel-world.mdx
+++ b/docs/content/docs/deploying/world/vercel-world.mdx
@@ -221,12 +221,12 @@ If workflows don't work after deployment:
1. Verify `withWorkflow()` is wrapping your Next.js config
2. Check build logs for errors
3. Ensure workflow files are in the correct directory
-4. Test locally first with [Embedded World](/docs/deploying/world/embedded-world)
+4. Test locally first with [Local World](/docs/deploying/world/local-world)
## Learn More
- [World Interface](/docs/deploying/world) - Understanding the World interface
-- [Embedded World](/docs/deploying/world/embedded-world) - For local development
+- [Local World](/docs/deploying/world/local-world) - For local development
- [Observability](/docs/observability) - Monitoring and debugging tools
- [Vercel Deployment Documentation](https://vercel.com/docs/deployments/overview)
- [Workflow Documentation on Vercel](https://vercel.com/docs/workflow)
Analysis
Broken documentation links after embedded-world to local-world rename
What fails: Documentation links in vercel-world.mdx point to /docs/deploying/world/embedded-world which no longer exists after the file was renamed to local-world.mdx, causing 404 errors when documentation is built or published.
How to reproduce:
- Check
docs/content/docs/deploying/world/vercel-world.mdxlines 224 and 229 - Verify that
embedded-world.mdxdoesn't exist:ls docs/content/docs/deploying/world/embedded-world.mdx(returns not found) - Verify that
local-world.mdxexists:ls docs/content/docs/deploying/world/local-world.mdx(returns file) - Attempt to follow documentation links - they will return 404
Result: Lines 224 and 229 contained broken links to /docs/deploying/world/embedded-world
Fixed: Updated both links to /docs/deploying/world/local-world to match the renamed documentation file:
- Line 224:
[Embedded World](/docs/deploying/world/embedded-world)→[Local World](/docs/deploying/world/local-world) - Line 229:
[Embedded World](/docs/deploying/world/embedded-world)→[Local World](/docs/deploying/world/local-world)
adriandlam
left a comment
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.
lgtm, seems like nuxt is failing probably because you're outdated
No description provided.