fix broken docs sidebar links (#193)

* fix migration guide link, add to sidebar

* add dokka gfm step, fix path

.github/workflows/Publish-Website.yml

@@ -1,8 +1,13 @@
 name: Publish the mkdocs to gh-pages
 
 on:
-  release:
-    types: [published]
+  push:
+    paths:
+      - "docs/**"
+      - "*.md"
+      - "mkdocs.yml"
+    branches:
+      - main
 
 env:
   GRADLE_OPTS: -Dorg.gradle.configureondemand=true -Dorg.gradle.parallel=true -Dkotlin.incremental=false -Dorg.gradle.jvmargs="-Xmx3g -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8"

.github/workflows/prepare_mkdocs.sh

@@ -10,6 +10,7 @@ set -ex
 
 # Generate the API docs
 bin/gradle dokkaHtml
+bin/gradle dokkaGfm
 
 # Dokka filenames like `-http-url/index.md` don't work well with MkDocs <title> tags.
 # Assign metadata to the file's first Markdown heading.

README.md

@@ -499,7 +499,7 @@ implementation "app.cash.tempest:tempest2:1.10.0"
 
 ## Migrating From Tempest 1 to Tempest 2
 
-Please follow the [Migration Guide](docs/guide/v2_upgrade_guide.md) that has been set up to upgrade from Tempest 1 (AWS SDK 1.x) to Tempest 2 (AWS SDK 2.x)
+Please follow the [Migration Guide](/guide/v2_upgrade_guide.md) that has been set up to upgrade from Tempest 1 (AWS SDK 1.x) to Tempest 2 (AWS SDK 2.x)
 
 ## License
 

build.gradle.kts

@@ -118,7 +118,7 @@ subprojects {
         }
 
         if (dokkaTask.name == "dokkaGfm") {
-          outputDirectory.set(project.file("$rootDir/docs/0.x"))
+          outputDirectory.set(project.file("$rootDir/docs/1.x"))
         }
       }
     }

mkdocs.yml

@@ -60,6 +60,7 @@ nav:
       - 'Testing': guide/testing.md
       - 'Asynchronous Programming': guide/asynchronous_programming.md
       - 'DynamoDB Resources': guide/dynamodb_resources.md
+      - 'v2 Migration Guide': guide/v2_uprgade_guide.md
 
   - 'Reference':
       - 'For AWS SDK 1.x':