From 6fb1d7231f83c1858fa96e3083fed273ad38d533 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sat, 27 Sep 2025 16:03:55 +0200 Subject: [PATCH] Update feature docs for clarity and links Improved the overview and write_online feature documentation by clarifying the description of the TeachBook template and updating its link. Also refined the summary section to specify error reporting per branch and release location. --- book/features/overview.md | 2 +- book/features/write_online.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/book/features/overview.md b/book/features/overview.md index 81a291f..e86e124 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -27,4 +27,4 @@ Finally, the purpose, installation process and usage of each features is elabora To see examples for these features, go to the [Examples chapter](../examples/overview.md). -As the [TeachBooks Python Package](./teachbooks_intro.md), the [Deploy Book Workflow](https://teachbooks.io/manual/external/deploy-book-workflow/README.html), [TeachBooks Favourites](./favourites.md) and the TeachBook template are important tools that incorporate and deploy more than one feature, an additional explanation is provided here in subpages in more detail, with links to the pages in this manual where individual features are described. \ No newline at end of file +As the [TeachBooks Python Package](./teachbooks_intro.md), the [Deploy Book Workflow](https://teachbooks.io/manual/external/deploy-book-workflow/README.html), [TeachBooks Favourites](./favourites.md) and the [TeachBook template](../external/template/README.md) are important tools that incorporate and deploy more than one feature, an additional explanation is provided here in subpages in more detail, with links to the pages in this manual where individual features are described. \ No newline at end of file diff --git a/book/features/write_online.md b/book/features/write_online.md index 3b64812..df0e1cb 100644 --- a/book/features/write_online.md +++ b/book/features/write_online.md @@ -26,8 +26,7 @@ After that, users can start writing and editing their book fully online in the G ## Example of summary -Whenever the workflow is triggered, its progress and a summary can be seen under the `Actions`- `All workflows` - `call-deploy-book` in GitHub! It shows you a descriptive summary. This summary includes, among others: -- Errors in the build process +Whenever the workflow is triggered, its progress and a summary can be seen under the `Actions`- `All workflows` - `call-deploy-book` in GitHub! It shows you a descriptive summary. This summary includes, among others, the errors in the build process per branch and where the book is released online. Here's an example for a summary for the template book: