Skip to content

Commit 286a7d6

Browse files
author
Murilo Marinho
committed
[TODO] Renamed from KNOWN_ISSUES.
1 parent 006573c commit 286a7d6

4 files changed

Lines changed: 24 additions & 12 deletions

File tree

KNOWN_ISSUES.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ This work is licensed under a
2323

2424
### Basic
2525

26-
See [The Basics of Kinematic Modeling and Control of Serial-link Manipulators Using `numpy`](basic_lessons/README.md) for robotic manipulators basics using `numpy`
26+
See [The Basics of Kinematic Modeling and Control of Serial-link Manipulators Using `numpy`](basic_lessons/README.md).
2727

2828

2929
### Advanced
3030

31-
See [Dual Quaternion Lessons Index](dqrobotics/README.md) for Kinematic modeling and control of serial-link robotic manipulators using `dqrobotics`: From zero to hero.
31+
See [Kinematic modeling and control of serial-link robotic manipulators using `dqrobotics`: From zero to hero.](dqrobotics/README.md).

TODO.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# TODO
2+
3+
## Known issues in `dqrobotics` lessons
4+
5+
1. Originally, the lessons written in `MATLAB` did not allow the use of latex macros. This means that the conversion from those to Jupyter notebooks brought notation as-is, which is not entirely compliant with the [latest notation](https://github.com/IncompleteGuides/lyx-macros). This is a very time consuming task so it will only be attempted with community support or further funding sources.
6+
1. The current `plot` method using `dqrobotics-pyplot` in the Jupyter notebook is generating a phantom image besides the animation videos. There are instructions online that allow us to tackle this issue, but I haven't been able to find one
7+
that properly shows the video but not the image.
8+
9+
## Text-based notebooks
10+
11+
- Converting from traditional Jupyter notebooks to text-based notebooks might be an interesting topic to explore. See
12+
[link](https://myst-nb.readthedocs.io/en/latest/authoring/text-notebooks.html#authoring-text-notebooks). Classic notebooks
13+
store cell output on itself, with implications on version control software. While classic Jupyter notebooks are more
14+
easily usable without extensions, `jupytext` seemingly allows for the conversions. See [link](https://jupyterbook.org/en/stable/file-types/myst-notebooks.html).

myst.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,14 @@ project:
2626
license:
2727
content:
2828
id: CC-BY-NC-SA-4.0
29+
#exports:
30+
# - format: pdf
31+
# date: 10 May 2023
32+
# https://github.com/myst-templates
33+
# template: plain_latex_book
34+
#article: basic_lessons/README.md
35+
# output: exports/basic_lessons.pdf
2936

30-
# exports:
31-
# - format: pdf
3237
toc:
3338
- file: README.md
3439
- title: "[Basic] Robotics using numpy"
@@ -51,7 +56,7 @@ project:
5156
- file: dqrobotics/lesson7/lesson_dq7_robot_control_basics_part3.ipynb
5257
- file: dqrobotics/lesson8/lesson_dq8_optimization_based_robot_control.ipynb
5358
- file: CHANGELOG.md
54-
- file: KNOWN_ISSUES.md
59+
- file: TODO.md
5560

5661
site:
5762
template: book-theme

0 commit comments

Comments
 (0)