Rename "Bash Completions" to "Shell Completions" (#2044)

See #2022 (comment)
urfave · Jan 13, 2025 · 435b91c · 435b91c
1 parent 7fc43e7
commit 435b91c
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/docs/v3/examples/bash-completions.md → docs/v3/examples/shell-completions.md b/docs/v3/examples/bash-completions.md → docs/v3/examples/shell-completions.md
diff --git a/mkdocs-reqs.txt b/mkdocs-reqs.txt
@@ -1,4 +1,5 @@
 mkdocs-git-revision-date-localized-plugin~=1.2
 mkdocs-material~=9.5
 mkdocs~=1.6
+mkdocs-redirects~=1.2
 pygments~=2.18
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,7 +28,7 @@ nav:
           - Subcommands Categories: v3/examples/subcommands-categories.md
           - Exit Codes: v3/examples/exit-codes.md
           - Combining Short Options: v3/examples/combining-short-options.md
-          - Bash Completions: v3/examples/bash-completions.md
+          - Shell Completions: v3/examples/shell-completions.md
           - Generated Help Text: v3/examples/generated-help-text.md
           - Version Flag: v3/examples/version-flag.md
           - Timestamp Flag: v3/examples/timestamp-flag.md
@@ -87,10 +87,15 @@ theme:
     - navigation.sections
     - navigation.tabs
     - navigation.tabs.sticky
+
 plugins:
   - git-revision-date-localized
   - search
+  - redirects:
+      redirect_maps:
+        'v3/examples/bash-completions.md': 'v3/examples/shell-completions.md'
   - tags
+
 # NOTE: this is the recommended configuration from
 # https://squidfunk.github.io/mkdocs-material/setup/extensions/#recommended-configuration
 markdown_extensions: