Fix issues with docs (#923)

microsoft · Oct 18, 2023 · 9ff6efa · 9ff6efa
1 parent f1c1cc1
commit 9ff6efa
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 23 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -1,4 +1,6 @@
-module.exports = {
+// @ts-check
+/** @type {import('@vuepress/types').Config} */
+const config = {
   title: 'beachball',
   description: 'The Sunniest Semantic Version Bumper',
   base: '/beachball/',
@@ -11,14 +13,12 @@ module.exports = {
     sidebar: [
       {
         title: 'Overview',
-        collapsable: false, // optional, defaults to true
-        sidebarDepth: 1, // optional, defaults to 1
+        collapsable: false,
         children: ['/overview/installation', '/overview/getting-started', '/overview/configuration'],
       },
       {
-        title: 'Concepts', // required
-        collapsable: false, // optional, defaults to true
-        sidebarDepth: 1, // optional, defaults to 1
+        title: 'Concepts',
+        collapsable: false,
         children: [
           '/concepts/bump-algorithm',
           '/concepts/change-files',
@@ -27,23 +27,21 @@ module.exports = {
         ],
       },
       {
-        title: 'Command Line Args', // required
-        collapsable: false, // optional, defaults to true
-        sidebarDepth: 1, // optional, defaults to 1
+        title: 'Command Line Args',
+        collapsable: false,
         children: ['/cli/options', '/cli/bump', '/cli/change', '/cli/check', '/cli/publish', '/cli/sync'],
       },
     ],
   },
-  plugins: [
-    [
-      'mermaidjs',
-      {
-        gantt: {
-          barHeight: 20,
-          fontSize: 12,
-          useWidth: 960,
-        },
+  plugins: {
+    mermaidjs: {
+      gantt: {
+        barHeight: 20,
+        fontSize: 12,
+        useWidth: 960,
       },
-    ],
-  ],
+    },
+  },
 };
+
+module.exports = config;
diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl
@@ -1,2 +1,2 @@
 $contentWidth ?= 960px
-$accentColor = darken(rgb(246, 224, 94), 30%)
+$accentColor = darken(#e1b10d, 10%)
diff --git a/docs/concepts/ci-integration.md b/docs/concepts/ci-integration.md
@@ -37,7 +37,7 @@ An alternative approach is creating a classic PAT with a "machine user" account.
 
 ### Storing tokens
 
-<h4 id="secrets-github-actions">GitHub Actions</h3>
+<h4 id="secrets-github-actions">GitHub Actions</h4>
 
 To restrict secret access to appropriate branches, use an **[environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)**. (The docs for environments focus on cloud deployments or resources, but environments can also be used only for secret storage.)
 
@@ -46,7 +46,7 @@ To restrict secret access to appropriate branches, use an **[environment](https:
 3. [Add secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment) for the npm and GitHub tokens.
 4. To [use the environment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#using-an-environment), add a key `environment: your-env-name` in your release workflow job. (Full example below.)
 
-<h4 id="secrets-azure-pipelines">Azure Pipelines</h3>
+<h4 id="secrets-azure-pipelines">Azure Pipelines</h4>
 
 There are a couple of options here: