update docs: start changelog / note on breaking changes

trappitsch · Mar 28, 2024 · e99b172 · e99b172
1 parent adf7bfa
commit e99b172
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/docs/changelog.md b/docs/changelog.md
diff --git a/docs/index.md b/docs/index.md
@@ -15,9 +15,13 @@ See [here](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 for details.
 
 !!! warning
-    This package is still in a very early
+    - This package is still in a very early
     development phase! Please report your findings and issues,
     so that we can improve this tool together.
+    - `box` is not yet production ready
+    and breaking changes may occur with new releases.
+    These will be noted in the release notes
+    and in the [changelog](changelog.md).
 
 ## Issues, comments, contributions,...
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -50,3 +50,4 @@ nav:
   - Home: index.md
   - CLI: cli.md
   - Usage guide: guide.md
+  - Changelog: changelog.md