docs(content-docs): Clarify the steps for entering docs-only mode

[juliuspr]

Pre-flight checklist

• [ ] I have read the Contributing Guidelines on pull requests.
• [ ] If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
• [ ] If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Test Plan

Test links

https://deploy-preview-8382--docusaurus-2.netlify.app/docs/docs-introduction/

https://deploy-preview-8382--docusaurus-2.netlify.app/docs/docs-only-mode/

Related issues/PRs

[facebook-github-bot]

Hi @juliuspr!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

[netlify[bot]]

✅ [V2]

Built without sensitive environment variables

Name	Link
🔨 Latest commit	7b9e61434f3d91be6c7a1d0264d6500fd5eee3f4
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/6383695100591b0008b7a37a
😎 Deploy Preview	https://deploy-preview-8382--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[github-actions[bot]]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 55	🟢 97	🟢 100	🟢 100	🟢 90	Report
/docs/installation	🟠 69	🟢 100	🟢 100	🟢 100	🟢 90	Report

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[Josh-Cena]

FWIW, I strongly oppose creating a separate page for docs-only. It's a maintenance churn while I don't really see much benefit to emphasize this concept at all: docs-only is a bad name—all it does is putting the docs plugin at the site root, but it doesn't prevent you from using blog either. The "three steps" mentioned here are all orthogonal:

1. The only required step in this entire process is using routeBasePath: "/" for docs. You don't have to disable blog.
2. You don't have to add slug: / for any doc: you can either add a redirect or continue using the old homepage (which means having two plugins using / as base path; iirc it had some glitches but still works)

As I see, this PR makes a fairly trivial concept draw too much reader attention without introducing any new materials.

[slorber]

I kind of agree although I didn't do a deep review of the new content 😅

Docs-only is a really bad term indeed, but it's a term that is easier to reference compared to routeBasePath: "/". Not sure how to get rid of it.

[slorber]

Related to https://github.com/facebook/docusaurus/pull/8405

We want blog/docs/pages docs to be consistent with each other and not repeat things everywhere

Let me know if you want to work on a better doc for the whole routeBasePath thing, otherwise we'll close both PR and handle this ourselves.