From be5b5c660f39e2808e5f69057be2b0246e37a55f Mon Sep 17 00:00:00 2001 From: Mikey O'Toole Date: Fri, 10 Nov 2023 18:03:18 +0000 Subject: [PATCH] docs: versioning docs should show example versioned sidebar files (#9500) Co-authored-by: Joshua Chen Co-authored-by: sebastienlorber --- website/docs/guides/docs/versioning.mdx | 31 +++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/website/docs/guides/docs/versioning.mdx b/website/docs/guides/docs/versioning.mdx index b473d69a1268..527a71facf02 100644 --- a/website/docs/guides/docs/versioning.mdx +++ b/website/docs/guides/docs/versioning.mdx @@ -145,6 +145,37 @@ versioned_sidebars/version-1.0.0-sidebars.json ``` +:::tip + +Versioned sidebar files are, like standard sidebar files, relative to the content root for the given version — so for the example above, your versioned sidebar file may look like: + +```json +{ + "sidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} +``` + +or for a manual sidebar: + +```json +{ + "sidebar": [ + { + "type": "doc", + "id": "new", + "label": "New" + } + ] +} +``` + +::: + ### Updating an existing version {#updating-an-existing-version} You can update multiple docs versions at the same time because each directory in `versioned_docs/` represents specific routes when published.