Skip to content

Commit

Permalink
update changelog and dev notes (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
nitram509 committed Sep 25, 2022
1 parent f9fe00d commit 9b118c7
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)```

Expand Down
7 changes: 6 additions & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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),
Expand Down

0 comments on commit 9b118c7

Please sign in to comment.