Merge branch 'main' into manual_description

book/_config.yml

@@ -1,14 +1,14 @@
 title: Template
 author: TeachBooks Team from Delft University of Technology, built with <a href="https://teachbooks.tudelft.nl/">TeachBooks</a> and <a href="https://jupyterbook.org/">Jupyter Book</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a> #add your own name here
-logo: figures/TUDelft_logo_rgb.svg #add your own logo here
+logo: figures/TB_logo.png #add your own logo here
 
 execute:
   execute_notebooks: "off"
 
 only_build_toc_files: true
 
 html:
-  favicon : "figures/favicon.ico"
+  favicon : "figures/TB_favicon.ico"
   baseurl :  "https://teachbooks.github.io/template/" #Replace this with your own URL
 
 sphinx:

book/_toc.yml

@@ -8,3 +8,5 @@ parts:
       sections:
       - file: some_content/text_and_code.ipynb
     - file: references.md
+    - file: changelog.md
+    - file: credits.md

book/changelog.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## `<date>` [`<release name>`](<`link to release on GitHub>`)
+- `<Added/modified/deleted>` [](`<relative link to changed file>`)

book/credits.md

@@ -0,0 +1,25 @@
+(credits)=
+# Credits and License
+
+You can refer to this book as:
+
+> `<editors>` (`<year>`) _`<title>`_. `<url to github repo>`
+
+The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors.
+
+You can refer to individual chapters or pages within this book as:
+
+> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>`
+
+We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location within the book. For example:
+
+> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.),  _`<title>`_. `<url to github repo>` (`./book/intro/` chapter, accessed November, 2024).
+
+## How the book is made
+
+This book is created using open source tools: it is a Jupyter Book that is written using Markdown, Jupyter notebooks and Python files to generate some figures. The files are stored on a [public GitHub repository](`<link to GitHub repo>`). The website can be viewed at `<link to book website url>`. View the repository README file or contact the authors for additional information.
+
+(editor)=
+## About the Editors
+
+### Acknowledgements