From 1427fb2dbadf2cc5ea9615f065ca584d8bebdde9 Mon Sep 17 00:00:00 2001
From: Michele Mesiti <michele.mesiti@kit.edu>
Date: Wed, 18 Mar 2026 09:42:25 +0100
Subject: [PATCH 1/3] Minimal fix of intro for 2026

- readthedocs.org -> ghpages
- mention personal/project page is optional
- plausible time table
- consistency between list of episodes
  and content of intro
---
 content/index.md | 25 +++++++++++++++----------
 1 file changed, 15 insertions(+), 10 deletions(-)

diff --git a/content/index.md b/content/index.md
index a8a4c693..e9ed62c0 100644
--- a/content/index.md
+++ b/content/index.md
@@ -3,19 +3,19 @@
 In this lesson we will discuss different solutions for implementing and
 deploying code documentation.
 
-We will start with a discussion about **what makes a good README**. For many
-projects, a README is more than enough.
+This demonstration will be **independent of programming languages**.
 
-We will then learn how to build documentation with the
-**documentation generator** [Sphinx](https://www.sphinx-doc.org) (and compare it
-with others) and how to
-deploy it to [Read the Docs](https://readthedocs.org), a service which hosts
-open documentation for free.
+We will discuss best practices, and briefly discuss the available tools.
 
-This demonstration will be **independent of programming languages**.
+Then we will discuss the form of documentation which is the most immediate to write:
+**in-code** comments, and docstrings.
+
+We will step up our game and discuss **what makes a good README**. For many
+projects, a curated README is enough.
 
-We will also learn how
-to deploy a **project website or personal homepage** to [GitHub Pages](https://pages.github.com).
+We will then learn how to build documentation with the
+**documentation generator** [Sphinx](https://www.sphinx-doc.org) and how to
+deploy it to [GitHub Pages](https://pages.github.com).
 The approach that we will learn will be transferable to
 [GitLab Pages](https://about.gitlab.com/features/pages/) and
 [Bitbucket Pages](https://pages.bitbucket.io).
@@ -33,6 +33,11 @@ If you wish to follow in the terminal and are new to the command line, we
 recorded a [short shell crash course](https://youtu.be/xbTTDLA3txI).
 ```
 
+An optional episode is about 
+deploying a **project website or personal homepage** 
+to [GitHub Pages](https://pages.github.com).
+
+
 ```{csv-table}
 :widths: auto
 :delim: ;

From a7497a9e6dc3a21b051513862efcf7bfc75fd1a0 Mon Sep 17 00:00:00 2001
From: Samantha Wittke <32324155+samumantha@users.noreply.github.com>
Date: Thu, 19 Mar 2026 12:27:54 +0200
Subject: [PATCH 2/3] add michele as contributor

---
 CITATION.cff | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/CITATION.cff b/CITATION.cff
index 9b44f109..4a357a9f 100644
--- a/CITATION.cff
+++ b/CITATION.cff
@@ -26,6 +26,8 @@ authors:
   given-names: "Kjartan Thor"
 - family-names: "Wittke"
   given-names: "Samantha"
+- family-names: "Mesiti"
+  given-names: "Michele"
 title: "How to document your research software"
 type: "dataset"
 abstract: "The lesson 'How to document your research software' gives an overview of the different ways how a code project can be documented: from small projects to larger projects. Markdown and Sphinx are central tools in this lesson."

From 3ecda636d3c22dd7ae43e3bdd786dc88d8b7ed37 Mon Sep 17 00:00:00 2001
From: Michele Mesiti <michele.mesiti@kit.edu>
Date: Thu, 19 Mar 2026 15:55:15 +0100
Subject: [PATCH 3/3] Clarify "independence of programming languages"

---
 content/index.md | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/content/index.md b/content/index.md
index e9ed62c0..b27eb8e6 100644
--- a/content/index.md
+++ b/content/index.md
@@ -3,7 +3,10 @@
 In this lesson we will discuss different solutions for implementing and
 deploying code documentation.
 
-This demonstration will be **independent of programming languages**.
+This demonstration will be mostly **independent of programming languages**
+(you will be able to follow and do all the exercises
+using the [CodeRefinery conda environment](https://coderefinery.github.io/installation/conda-environment/)).
+
 
 We will discuss best practices, and briefly discuss the available tools.