docs: cleanup documentation files

Author: ashenBlade

dev/docs.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+
+# Script for working with documentation (./docs folder).
+# These commands are simple, but after a few weeks off everyone will forget them,
+# so this script is a lifesaver
+
+function print_help {
+    cat <<EOF
+    Usage: $0 [--help] COMMAND
+
+Wrapper around mkdocs to manage documentation folder.
+
+--help   - show this help message
+
+COMMAND is an action to perform:
+    build - only build documentation
+    serve - build documentation and start local server
+    deploy - build documentation and deploy it to github pages
+
+
+Examples:   $0 build
+            $0 deploy
+            $0 --help
+EOF
+}
+
+if [[ "$1" == "--help" || "$1" == "-h" ]]; then
+    print_help
+    exit 0
+fi
+
+# Normalize directory - root of repository
+cd -- "$(dirname "${BASH_SOURCE[0]:-$0}")/.."
+
+# mkdocs is a python tool
+source .venv/bin/activate
+
+if [[ "$1" == "build" || "$1" == "b" ]]; then
+    mkdocs build --strict
+elif [[ "$1" == "serve" || "$1" == "s" ]]; then
+    mkdocs serve -o
+elif [[ "$1" == "deploy" || "$1" == "d" ]]; then
+    mkdocs gh-deploy
+else
+    echo "unknown command $1"
+    exit 1
+fi

dev/gif-converter.sh

@@ -4,8 +4,6 @@
 # This uses FFMPEG with palette generation (for more
 # beautiful picture)
 
-# Exit on first error + Echo all commands
-
 function print_help {
     echo "Usage: $0 VIDEO_FILE [OUTPUT_FILE]
 
@@ -22,6 +20,7 @@ if [[ "$1" == "--help" || $1 == "-h" ]]; then
     exit 0
 fi
 
+# Exit on first error + Echo all commands
 set -ex
 VIDEO_FILE="$1"
 

docs/index.md

@@ -21,7 +21,8 @@ During debug session separate view `PG Variables` shows contents of variables wi
     - `bitmapword`
     - `XLogRecPtr`
     - `RelFileLocator`
-  
+- Show attribute values of `TupleTableSlot`
+
 ![Variables view](./img/overview.gif)
 
 You can define your own custom types, i.e. your own array variable using [configuration file](./configuration.md).

docs/vscode_setup.md

@@ -32,26 +32,26 @@ PostgreSQL has different test types. One of them is TAP-tests which are written
 
 Example, [Perl](https://marketplace.visualstudio.com/items?itemName=richterger.perl) extension.
 
-> If you have chosen extension above, then you should know, that this extension caches parsed `*.pl` files and stores them in `.vscode/perl-lang` directory (can be changed in settings).
-> Such behavior can interfere with other IDE functions (i.e. file search) or slow down performance, so you should add this folder to excludes.
-> Sample configuration can look like this (`settings.json`):
->
-> ```json
-> {
->     // Exclude from search output list
->     "search.exclude": {
->         "**/.vscode/perl-lang": true
->     },
->     // Exclude from tracked FS events
->     "files.watcherExclude": {
->         "**/.vscode/perl-lang": true
->     },
->     // Do not even show this directory in explorer
->     "files.exclude": {
->         "**/.vscode/perl-lang": true
->     }
-> }
-> ```
+If you have chosen extension above, then you should know, that this extension caches parsed `*.pl` files and stores them in `.vscode/perl-lang` directory (can be changed in settings).
+Such behavior can interfere with other IDE functions (i.e. file search) or slow down performance, so you should add this folder to excludes.
+Sample configuration can look like this (`settings.json`):
+
+```json
+{
+    // Exclude from search output list
+    "search.exclude": {
+        "**/.vscode/perl-lang": true
+    },
+    // Exclude from tracked FS events
+    "files.watcherExclude": {
+        "**/.vscode/perl-lang": true
+    },
+    // Do not even show this directory in explorer
+    "files.exclude": {
+        "**/.vscode/perl-lang": true
+    }
+}
+```
 
 ### Markdown
 
@@ -206,7 +206,7 @@ C/C++ extension has special configuration for debugging CoreDump:
     "version": "0.2.0",
     "configurations": [
         {
-            "name": "pg_ctl",
+            "name": "CoreDump",
             "type": "cppdbg",
             "request": "launch",
             "program": "${workspaceFolder}/src/backend/postgres",