diff --git a/README.md b/README.md index 2c274bd84..f8daf8b24 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,11 @@ If you are making changes to the book please note the following: * Our style guide is provided [here in the introduction](https://mlr3book.mlr-org.com/chapters/chapter1/introduction_and_overview.html#styleguide) * Where possible, figures in the HTML book should be svgs and figures in the PDF should be pdf. These should be included with `knitr::include_graphics()` or ideally with [include_multi_graphics()](https://github.com/mlr-org/mlr3book/blob/main/book/common/_utils.qmd). + +When (non-trivial) changes and corrections are made to chapters that are are included in the first published edition of this book, these changes should be documented in the *Errata* appendix. +When adding new chapters to the book not present in the published version, these should be marked as *Online Only* in their title. +For such newly added chapters that are in early stages and have not been rigorously edited and reviewed, these should be additionally marked as being a *Draft*. + * If you add a new package dependency to the book, please follow the following steps to update the lockfile: * Start an R session in the `book/` directory * Activate the project with `renv::activate()` diff --git a/book/_quarto.yml b/book/_quarto.yml index 5a2d660eb..e9868b338 100644 --- a/book/_quarto.yml +++ b/book/_quarto.yml @@ -49,6 +49,7 @@ book: - chapters/appendices/solutions.qmd # online only - chapters/appendices/tasks.qmd # online only - chapters/appendices/overview-tables.qmd # online only + - chapters/appendices/errata.qmd # online only bibliography: book.bib diff --git a/book/chapters/appendices/errata.qmd b/book/chapters/appendices/errata.qmd new file mode 100644 index 000000000..0f0954a42 --- /dev/null +++ b/book/chapters/appendices/errata.qmd @@ -0,0 +1,12 @@ +--- +aliases: + - "/errata.html" +--- + +# Errata {#sec-appendix-errata} + +::: {.content-visible when-format="html"} + +{{< include ../../common/_setup.qmd >}} + +This appendix lists changes to the online version of this book to chapters included in the first edition.