refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar

[Josh-Cena]

Breaking changes

Nothing complicated to upgrade, and validation errors will tell you what to do:

• themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable
• themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories

So if you previously had:

const config = {
  themeConfig: {
    hideableSidebar: true,
    autoCollapseSidebarCategories: true,
  },
};

Change it to:

const config = {
  themeConfig: {
    docs: {
      sidebar: {
        hideable: true,
        autoCollapseCategories: true,
      },
    },
  },
};

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

We are having more and more theme config options that are at the root. To make things more scalable in the future, I propose to namespace them all under docs.sidebar.

Test Plan

Added two tests to verify that validation schema works.

[Josh-Cena]

This API is, AFAIK, undocumented. Is it intended for usage by anyone? I initially thought about docsSidebar so there's some degree of parallel with navbar and footer, but because of the existence of this field, I eventually put it in docs.sidebar, with one extra level of nesting.

[slorber]

We should likely document versionPersistence, implemented in #3543

Note some sites may want to minimize the usage of local storage. But it may have been me misinterpreting the GDPR rules and may not be that useful to provide an option for it 🤷‍♂️

---

Nesting docs.sidebar doesn't look like a bad idea anyway, still related to preemptive pluralization 🤪

[netlify]

✅ [V2]

Name	Link
🔨 Latest commit	d95c2e2
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/626d16561461df0009a36487
😎 Deploy Preview	https://deploy-preview-7277--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]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	44
🟢 Accessibility	100
🟢 Best practices	92
🟢 SEO	100
🟢 PWA	90

Lighthouse ran on https://deploy-preview-7277--docusaurus-2.netlify.app/

[github-actions]

Size Change: -4 B (0%)

Total Size: 806 kB

ℹ️ View Unchanged

Filename	Size	Change
website/.docusaurus/globalData.json	50.7 kB	0 B
website/build/assets/css/styles.********.css	107 kB	0 B
website/build/assets/js/main.********.js	610 kB	-4 B (0%)
website/build/index.html	38.8 kB	0 B

_{compressed-size-action}

[slorber]

👍 looks like a nice improvement to do

[slorber]

We should likely document versionPersistence, implemented in #3543

Note some sites may want to minimize the usage of local storage. But it may have been me misinterpreting the GDPR rules and may not be that useful to provide an option for it 🤷‍♂️

---

Nesting docs.sidebar doesn't look like a bad idea anyway, still related to preemptive pluralization 🤪