[book.md] Added instructions and further information about making your own book,

Author: Murilo M. Marinho

basic_lessons/README.md

@@ -1,11 +1,7 @@
----
-title: Introduction
-...
+# The Basics of Kinematic Modeling and Control of Serial-link Manipulators Using `numpy`
 
-## The Basics of Kinematic Modeling and Control of Serial-link Manipulators Using `numpy`
-
-  In this five-lesson tutorial, we start from the very basics of scalar and matricial operations in Python using `numpy`,
-  all the way until the basics of kinematic control. Until kinematic control, most is based on [@spong2020robot].
+In this five-lesson tutorial, we start from the very basics of scalar and matricial operations in Python using `numpy`,
+all the way until the basics of kinematic control. Until kinematic control, most is based on [@spong2020robot].
 
 # Using this book
 

book.md

@@ -0,0 +1,123 @@
+# Making your own executable book 
+
+```{warning}
+  This notebook is a work in progress. This is based on `Jupyter Book 2.0` which is currently in alpha, meaning that
+  it might change considerably before release.
+```
+
+```{seealso}
+  - Jupyter book: https://next.jupyterbook.org
+  - MyST: https://mystmd.org/guide/
+```
+
+## Dependencies
+
+Remember to set a `venv` first. The Python policies are becoming evermore stringent in this regard.
+
+```commandline
+python -m venv venv
+source venv/bin/activate
+```
+
+Installation can be done as follows.
+
+```{important}
+  The `--pre` flag is important while this version is not released.
+```
+
+```commandline
+python -m pip install jupyter-book --pre
+```
+
+## Cloning or downloading the repository
+
+To clone, please use the usual.
+
+```commandline
+git clone https://github.com/MarinhoLab/OpenExecutableBooksRobotics.git
+```
+
+Further, the package can be downloaded from [here](https://github.com/MarinhoLab/OpenExecutableBooksRobotics/archive/refs/heads/main.zip).
+
+## Building the book
+
+### Live document
+
+```commandline
+jupyter book start
+```
+
+Then click on the link, output below
+
+```
+     ✨✨✨  Starting Book Theme  ✨✨✨
+
+
+
+🔌 Server started on port 3000!  🥳 🎉
+
+
+        👉  http://localhost:3000  👈
+
+```
+
+which usually, as described, connects to `http://localhost:3000`.
+
+### Building the HTML
+
+```
+jupyter book build --html
+```
+
+If needed, the page can be opened at `_build/html/index.html`.
+
+## Notebook configuration
+
+In this version of jupyter notebook, `myst.yml` is the soul of the book. It is very uncommon that `conf.py` is needed.
+
+```{literalinclude} myst.yml
+```
+
+Everything in `myst.yml` is standard, aside from the following block.
+
+```{literalinclude} myst.yml
+:start-at: #USING DQROBOTICS DEVEL [START]
+:end-at: #USING DQROBOTICS DEVEL [END]
+```
+
+This is a temporary solution to address notebooks that do not play well together. Currently, a jupyter book spawns one process
+of each notebook and results can be nondeterministic if notebooks can affect each other. More information can be seen
+[here](https://github.com/jupyter-book/mystmd/issues/1794).
+
+I'm combining that block with a simple use of `sed` to guarantee the initial lessons that use the stable version of `dqrobotics`
+run before lessons that need the development version of `dqrobotics.` For more information, see the file below.
+
+```{literalinclude} build_html.sh
+```
+
+We currently only need `conf.py` below for math commands in MySt documents.
+
+```{literalinclude} conf.py
+```
+
+## Deployment in GitHub
+
+```{important}
+  It is very common for GitHub Actions to change how it works internally. This can affect, for instance, the version of the
+  images run by the GitHub Actions runners, how GitHub Pages works, or how artifact upload works. If the workflow mentioned
+  herein no longer works in the future, it is important to look at initially newer versions of the imported actions.
+  Currently:
+  - `actions/checkout@v4`
+  - `actions/upload-pages-artifact@v3`
+  - `actions/configure-pages@v4`
+  - `actions/deploy-pages@v4`
+```
+
+This workflow is straightforward and effective. The only external action needed is to set, in your repository,
+`⚙Settings > Pages > Build and deployment > Source > GitHub Actions`.
+
+
+```{literalinclude} .github/workflows/notebook_to_html.yml
+```
+
+

dqrobotics/README.md

@@ -1,6 +1,4 @@
-# Introduction
-
-## Kinematic modeling and control of serial-link robotic manipulators using `dqrobotics` Python: From zero to hero.
+# Kinematic modeling and control of serial-link robotic manipulators using `dqrobotics` Python: From zero to hero.
 
 This executable book contains eight lessons representing serial-link manipulator modeling in dual quaternions using `dqrobobotics` described in http://doi.org/10.1109/MRA.2020.2997920. It is a derivative
 work of a [`dqrobotics` MATLAB course](https://github.com/dqrobotics/learning-dqrobotics-in-matlab/tree/master/robotic_manipulators) from Murilo M. Marinho.

myst.yml

@@ -50,6 +50,7 @@ project:
         - file: dqrobotics/lesson6/lesson_dq6_robot_control_basics_part2.ipynb
         - file: dqrobotics/lesson7/lesson_dq7_robot_control_basics_part3.ipynb
         - file: dqrobotics/lesson8/lesson_dq8_optimization_based_robot_control.ipynb
+    - file: book.md
     - file: CHANGELOG.md
     - file: TODO.md
 #USING DQROBOTICS DEVEL [START]