Manual release notes and changelog fiddlin

ponylang · Nov 7, 2022 · eadf381 · eadf381
1 parent e5e8b97
commit eadf381
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 8 deletions.
diff --git a/.release-notes/4226.md b/.release-notes/4226.md
diff --git a/.release-notes/next-release.md b/.release-notes/next-release.md
@@ -16,3 +16,12 @@ This could lead to very surprising results if `reserve` had been called by `unde
 
 In order to make documentation on a class, actor, primitive or struct easier to find, they are now sorted alphabetically inside their package.
 
+## Adapt docgen to only depend the mkdocs material theme
+
+We used to have our own mkdocs theme for ponylang documentation, it was based off of the mkdocs-material theme. This change puts the adaptationswe need into the mkdocs.yml file itself, so we don't depend on our own theme anymore, but only on the upstream mkdocs-material.
+
+This is a **Breaking Change** in so far that users that want to generate documentation with ponyc now have to install the python package `mkdocs-material` instead of `mkdocs-ponylang` to generate their documentation in HTML form with mkdocs. The [library documentation github action](https://github.com/ponylang/library-documentation-action) will have the correct dependencies installed, so no changes should be needed when using it.
+
+## Fix broken docgen on Windows
+
+Generating documentation has been broken on windows: `ponyc` was not able to write the documentation files, due to path handling issues on windows. This is now fixed and docgen is working again on windows.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,13 +8,14 @@ All notable changes to the Pony compiler and standard library will be documented
 
 - Avoid fairly easy to trigger overflow in Windows Time.nanos code ([PR #4227](https://github.com/ponylang/ponyc/pull/4227))
 - Fix incorrect interaction between String/Array reserve and Pointer realloc ([PR #4223](https://github.com/ponylang/ponyc/pull/4223))
+- Fix broken docgen on Windows ([PR #4226](https://github.com/ponylang/ponyc/pull/4223))
 
 ### Added
 
-
 ### Changed
 
 - Sort package types in documentation ([PR #4228](https://github.com/ponylang/ponyc/pull/4228))
+- Adapt docgen to use the mkdocs material theme ([PR #4226](https://github.com/ponylang/ponyc/pull/4226)
 
 ## [0.51.4] - 2022-10-29