fix: improve sidebar accessibility structure (#8429)

packages/docusaurus-theme-classic/src/theme/DocSidebar/Desktop/index.tsx

@@ -24,16 +24,19 @@ function DocSidebarDesktop({path, sidebar, onCollapse, isHidden}: Props) {
   } = useThemeConfig();
 
   return (
-    <div
+    <nav
       className={clsx(
         styles.sidebar,
         hideOnScroll && styles.sidebarWithHideableNavbar,
         isHidden && styles.sidebarHidden,
-      )}>
-      {hideOnScroll && <Logo tabIndex={-1} className={styles.sidebarLogo} />}
+      )}
+      aria-label="docs sidebar">
+      {hideOnScroll && (
+        <Logo tabIndex={-1} className={styles.sidebarLogo} aria-hidden="true" />
+      )}
       <Content path={path} sidebar={sidebar} />
       {hideable && <CollapseButton onClick={onCollapse} />}
-    </div>
+    </nav>
   );
 }
 

packages/docusaurus/package.json

@@ -47,7 +47,6 @@
     "combine-promises": "^1.1.0",
     "commander": "^5.1.0",
     "core-js": "^3.31.1",
-    "del": "^6.1.1",
     "detect-port": "^1.5.1",
     "escape-html": "^1.0.3",
     "eta": "^2.2.0",

packages/docusaurus/src/commands/build/buildLocale.ts

@@ -26,6 +26,7 @@ import type {
 } from '@docusaurus/types';
 import type {SiteCollectedData} from '../../common';
 import {BuildCLIOptions} from './build';
+import clearPath from '../utils/clearPath';
 
 export type BuildLocaleParams = {
   siteDir: string;
@@ -77,6 +78,11 @@ export async function buildLocale({
             props,
             configureWebpackUtils,
           }),
+
+          // We also clear website/build dir
+          // returns void, no useful result needed before compilation
+          // See also https://github.com/facebook/docusaurus/pull/11037
+          clearPath(outDir),
         ]),
     );
 

packages/docusaurus/src/commands/clear.ts

@@ -12,13 +12,14 @@ import {
   DEFAULT_BUILD_DIR_NAME,
   GENERATED_FILES_DIR_NAME,
 } from '@docusaurus/utils';
+import clearPath from './utils/clearPath';
 
 async function removePath(entry: {path: string; description: string}) {
   if (!(await fs.pathExists(entry.path))) {
     return;
   }
   try {
-    await fs.remove(entry.path);
+    await clearPath(entry.path);
     logger.success`Removed the ${entry.description} at path=${path.relative(
       process.cwd(),
       entry.path,

packages/docusaurus/src/commands/utils/clearPath.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import path from 'path';
+import {rm} from 'fs/promises';
+import {PerfLogger} from '@docusaurus/logger';
+
+/**
+ * @param pathToClear
+ */
+export default async function clearPath(pathToClear: string): Promise<void> {
+  return PerfLogger.async(
+    `clearPath ${path.relative(process.cwd(), pathToClear)}`,
+    async () => {
+      await rm(pathToClear, {recursive: true, force: true});
+    },
+  );
+}

packages/docusaurus/src/webpack/client.ts

@@ -13,7 +13,6 @@ import HtmlWebpackPlugin from 'html-webpack-plugin';
 import {getProgressBarPlugin} from '@docusaurus/bundler';
 import {createBaseConfig} from './base';
 import ChunkAssetPlugin from './plugins/ChunkAssetPlugin';
-import CleanWebpackPlugin from './plugins/CleanWebpackPlugin';
 import ForceTerminatePlugin from './plugins/ForceTerminatePlugin';
 import {createStaticDirectoriesCopyPlugin} from './plugins/StaticDirectoriesCopyPlugin';
 import type {
@@ -164,8 +163,6 @@ export async function createBuildClientConfig({
     {
       plugins: [
         new ForceTerminatePlugin(),
-        // Remove/clean build folders before building bundles.
-        new CleanWebpackPlugin({verbose: false}),
         // Visualize size of webpack output files with an interactive zoomable
         // tree map.
         bundleAnalyzer && new BundleAnalyzerPlugin(),

project-words.txt

@@ -1,7 +1,6 @@
 # Project Words - DO NOT TOUCH - This is updated through CI
 abernathyca
 Adriaan
-Agan
 alexbdebrie
 Alexey
 algoliasearch

yarn.lock

@@ -7339,7 +7339,7 @@ define-properties@^1.1.3, define-properties@^1.1.4, define-properties@^1.2.0, de
     has-property-descriptors "^1.0.0"
     object-keys "^1.1.1"
 
-del@^6.0.0, del@^6.1.1:
+del@^6.0.0:
   version "6.1.1"
   resolved "https://registry.yarnpkg.com/del/-/del-6.1.1.tgz#3b70314f1ec0aa325c6b14eb36b95786671edb7a"
   integrity sha512-ua8BhapfP0JUJKC/zV9yHHDW/rDoDxP4Zhn3AkA6/xT6gY7jYXJiaeyBZznYVujhZZET+UgcbZiQ7sN3WqcImg==