From 9b118c7e5345102a5104a890393d90c58600f5d1 Mon Sep 17 00:00:00 2001 From: nitram509 Date: Sun, 25 Sep 2022 15:59:14 +0200 Subject: [PATCH] update changelog and dev notes (#58) --- CHANGELOG.md | 2 +- DEVELOPMENT.md | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 716341c2..8d414118 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,7 +5,7 @@ - support handlers being registered for (task definition) types (#58 BREAKING CHANGE) -### Migration notes for breaking changes +## Migration notes for breaking changes - replace ```AddTaskHandler("id", handlerFunc)``` with ```NewTaskHandler.Id("id").Handler(handlerFunc)``` diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index a2ea60a1..8c708a3a 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -16,11 +16,16 @@ The documentation on Github pages is build via [MkDocs](https://www.mkdocs.org/) 1. ensure you have a Python 3.8+ environment installed 2. install MkDocs, according to their https://www.mkdocs.org/user-guide/installation/ + * shortcut: ```pip3 install -r doc-requirements.txt``` 3. within this source repo, run ```mkdocs build``` to get a version of the HTML files -Alternatively, you could use ```mkdocs serve``` to have a local test-server running, +Alternatively, you could use a local test-server, which eases the manual validation/verification of documentation updates. +```shell +mkdocs serve +``` + #### automated Github Pages update There's a Github Action [update-gh-pages.yaml](./.github/workflows/update-gh-pages.yml),