Merge pull request #291 from coding-for-reproducible-research/learnr_website_alignment

LearnR and website alignment

Author: liamjberrisford

contributing/contributing_guidelines.ipynb

@@ -26,6 +26,10 @@
     "\n",
     "For R courses, we recommend using **learnr** tutorials where appropriate. The learnr package in R enables the development of interactive tutorials that incorporate markdown-formatted text, R code examples, exercises, and quizzes. This format is especially well-suited to R instruction, as it offers learners hands-on practice with immediate feedback within a single, cohesive document. However, if the course content is better served by an alternative format, instructors are encouraged to use their professional judgment in selecting the most effective approach.\n",
     "\n",
+    "```{important}\n",
+    "If you are updating a course that includes a learnr tutorial (e.g., Regression Analysis with R), please ensure that any changes made to the learnr content are also reflected in the corresponding self-study notes on the website, so the two remain aligned.\n",
+    "```\n",
+    "\n",
     "These tutorials are distrbuted as an R package [cfrr-r-tutorials](https://github.com/coding-for-reproducible-research/cfrr-r-tutorials) and should be developed in that repo. A homepage, with details on the course and instructions for how to launch the tutorial should be included in this repo. \n",
     "\n",
     "#### Guidelines for R Courses:\n",
@@ -36,6 +40,8 @@
     "- Use clear and concise explanations in markdown to guide learners through the content.\n",
     "- Test all tutorials to ensure they function correctly and provide accurate feedback.\n",
     "\n",
+    "\n",
+    "\n",
     "## Course Delivery\n",
     "\n",
     "Courses may be delivered in different ways depending on the tools available and the nature of the content. It's important to adhere to the standards outlined above to maintain consistency and quality across all courses.\n",