Add migration section to docs

can-lehmann · Sep 16, 2023 · 1e43ab8 · 1e43ab8
1 parent e64ebde
commit 1e43ab8
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/book/migration.md b/book/migration.md
@@ -0,0 +1 @@
+# Migration
diff --git a/docs/migrating_2_to_3.md b/docs/migrating_2_to_3.md
@@ -0,0 +1,7 @@
+# Migrating from Owlkettle 2.x.x to 3.0.0 (devel)
+
+## Breaking Changes
+
+- `FileChooserDialogState.filename` has been deprecated. Use `filenames` instead.
+- The `{.internal.}` pragma has been removed. Use `{.private.}` instead.
+  Contrary to `{.internal.}`, `{.private.}` actually does not export the given field.
diff --git a/nbook.nim b/nbook.nim
@@ -37,6 +37,11 @@ var book = initBookWithToc:
     entry("Setters", "internals/setters.nim")
 
   entry("Tooling", "docs/recommended_tools.md")
+
+  section("Migration", "book/migration.md"):
+    entry("1.x.x to 2.0.0", "../docs/migrating_1_to_2.md")
+    entry("2.x.x to 3.0.0 (devel)", "../docs/migrating_2_to_3.md")
+
   entry("Contributing", "CONTRIBUTING.md")
 
   section("Legal", "book/legal/legal.md"):