From aa06b091a8b01dead2943f219b7e1f5f5d570818 Mon Sep 17 00:00:00 2001
From: silasprincipe <53846571+silasprincipe@users.noreply.github.com>
Date: Wed, 9 Oct 2024 15:45:36 +0200
Subject: [PATCH] Update README.md

---
 notebooks/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/notebooks/README.md b/notebooks/README.md
index 92307ae..8be9fe2 100644
--- a/notebooks/README.md
+++ b/notebooks/README.md
@@ -15,4 +15,23 @@ Here we present some notebooks covering several topics as OBIS data access, data
 
 
 ------
+
+Note for developers:
+
+There is a GitHub actions configured for this repository. It will render any .ipynb or .qmd files added to either the Python or R folders, get a screenshot of the document and add it to this README. Code cells are **not** executed.
+
+Avoid editing this README file, as the script might start adding duplicated entries here.
+
+For Quarto (.qmd) files, there are two important requirements:
+
+1. Don't add any inline R code (like `r data_vector[1]`), otherwise the code will fail.
+2. Add the option of embedding resources on the Quarto header:
+
+``` {bash}
+title: "any title"
+format: 
+  html:
+    embed-resources: true
+```
+
 _Created by the OBIS secretariat_
\ No newline at end of file