Change the docs-only section to clearly state, why you should delete index page

📚 Documentation

Now the (docs-only section) states that: You should delete the existing homepage at ./src/pages/index.js, or else there will be two files mapping to the same route!. But as I found out, you can keep the file at ./src/pages/index.js, but some markdown features like syntax highlighting wont work.

I propose to change it to something like this: You should delete the existing homepage at ./src/pages/index.js, or else some features like syntax highlighting wont work

Have you read the Contributing Guidelines on issues?

Yes

[slorber]

@svict4 I’m going to make a release as soon as possible and it should fix this issue. On the new release, you won’t ever have a doc home with no navbar/sidebar (this is definitively a bug that shouldn’t have happened in the first place).

If you keep the file in /pages/index.js, it will keep showing the homepage consistently (just checked, it does), and you should be able to figure out yourself that you need to delete it.

Not this release, but the next one, will also show an exception/error/warning when such route conflict happens (WIP: https://github.com/facebook/docusaurus/pull/3083)

I think the code will itself prevent users from doing the wrong thing. Wonder what’s your opinion. If you feel we need to make the doc more clear, PRs are welcome

[svict4]

Just want to add that there have been multiple questions about missing sidebars/headers/footers (from myself included) on Discord that relates to forgetting to remove the ./src/pages/index.js file when in docs-only mode