-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
Update blog.mdx #9811
Update blog.mdx #9811
Conversation
The current documentation says to add a routebasepath and set docs to false. This ends up with an error when starting the application. When removing the sidebar doc item it works as expected.
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Similar to #9810 I can't merge this PR as is. I need you to explain properly the problem in the first place and why this extra doc is useful. More importantly the user need to understand the reason behind these extra instructions. |
When installing a brand new installation and attempt to have blog/doc mode only, the instructions tell you to navigate to docusaurus.config.js and set the blog or docs to false depending on what the user is wanting to acheive. The application then fails and the user is stuck with the following error: To remove the docusaurus-plugin-content-docs error the user will need to navigate to the themeConfig within the docusaurus.config.js and remove:
The application will work as expected. This removal should be pointed out in the documentation as it does not work as expected. |
The error message you screenshotted here is incomplete, please don't truncate error messages and screenshot/copy/paste them fully, they contain meaningful information (includig the stacktrace). IMHO this is a DX problem, not a docs problem. The error message is likely not clear enough for the user to troubleshoot it. If the error message told you which element to remove from |
I've tried on my end by creating a repro locally, I've set in And if we click on the button we have this similar error We can add a second warning in the documentation below the one mentioning about
|
@imjustablacknerd we improved a bit the situation in #9839 |
Thanks! |
The current documentation says to add a routebasepath and set docs to false.
This ends up with an error when starting the application.
When removing the sidebar doc item it works as expected.
Pre-flight checklist
Motivation
Test Plan
Test links
Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/
Related issues/PRs