From e99b17230a9dbe81addee78ec7e6e72ba8763b56 Mon Sep 17 00:00:00 2001 From: Reto Trappitsch Date: Thu, 28 Mar 2024 10:30:44 +0100 Subject: [PATCH] update docs: start changelog / note on breaking changes --- docs/changelog.md | 0 docs/index.md | 6 +++++- mkdocs.yml | 1 + 3 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 docs/changelog.md diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/index.md b/docs/index.md index c502649..158c9d4 100644 --- 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 index 5262db2..c6aabf8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -50,3 +50,4 @@ nav: - Home: index.md - CLI: cli.md - Usage guide: guide.md + - Changelog: changelog.md