update: docs with new release notes + fix typo

bbglab · Jul 25, 2024 · d925079 · d925079
1 parent dc192d4
commit d925079
Show file tree

Hide file tree

Showing 5 changed files with 170 additions and 160 deletions.
diff --git a/docs/examples/cli/introduction_cli.ipynb b/docs/examples/cli/introduction_cli.ipynb
@@ -2,33 +2,39 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "source": [
-    "# Introduction"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "# Introduction"
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "**OpenVariant** offers a command-line interface (CLI) with the main tasks that also can be applied in Python scripts.\n",
-    "\n",
-    "On the following command you can check the different options that `openvar` can run."
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "**OpenVariant** offers a command-line interface (CLI) with the main tasks that also can be applied in Python scripts.\n",
+    "\n",
+    "On the following command you can check the different options that `openvar` can run."
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 1,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -55,29 +61,29 @@
    "source": [
     "%%bash\n",
     "openvar --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Cat*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Cat** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 2,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -99,29 +105,29 @@
    "source": [
     "%%bash\n",
     "openvar cat --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Count*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Count** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 3,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -145,29 +151,29 @@
    "source": [
     "%%bash\n",
     "openvar count --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Group by*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Group by** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 4,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -195,29 +201,29 @@
    "source": [
     "%%bash\n",
     "openvar groupby --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   },
   {
    "cell_type": "markdown",
-   "source": [
-    "### ***Plugin*** command"
-   ],
    "metadata": {
     "collapsed": false,
     "pycharm": {
      "name": "#%% md\n"
     }
-   }
+   },
+   "source": [
+    "### **Plugin** command"
+   ]
   },
   {
    "cell_type": "code",
    "execution_count": 5,
+   "metadata": {
+    "collapsed": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -237,13 +243,7 @@
    "source": [
     "%%bash\n",
     "openvar plugin --help"
-   ],
-   "metadata": {
-    "collapsed": false,
-    "pycharm": {
-     "name": "#%%\n"
-    }
-   }
+   ]
   }
  ],
  "metadata": {
@@ -267,4 +267,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 0
-}
+}
diff --git a/docs/examples/cli/main_cli.ipynb b/docs/examples/cli/main_cli.ipynb
@@ -37,7 +37,7 @@
     }
    },
    "source": [
-    "### ***Cat*** command\n",
+    "### **Cat** command\n",
     "\n",
     "A simple case of the command:"
    ]
@@ -118,7 +118,7 @@
     }
    },
    "source": [
-    "### ***Count*** command\n",
+    "### **Count** command\n",
     "\n",
     "A simple case of the command:"
    ]
@@ -231,7 +231,7 @@
     }
    },
    "source": [
-    "### ***Group by*** command\n",
+    "### **Group by** command\n",
     "\n",
     "A simple case of the command:"
    ]
@@ -354,7 +354,7 @@
    },
    "source": [
     "\n",
-    "### ***Plugin*** command\n",
+    "### **Plugin** command\n",
     "\n",
     "_Plugin_ is slightly different than the others commands.\n",
     "\n",