From 1fc637a129188c4f3a21fc85884bd122b8301519 Mon Sep 17 00:00:00 2001 From: Danny Marc Rotscher <danny.rotscher@tu-dresden.de> Date: Mon, 14 Jun 2021 09:22:41 +0000 Subject: [PATCH] Added README.md for the utils directory --- doc.zih.tu-dresden.de/util/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc.zih.tu-dresden.de/util/README.md diff --git a/doc.zih.tu-dresden.de/util/README.md b/doc.zih.tu-dresden.de/util/README.md new file mode 100644 index 000000000..20b503d53 --- /dev/null +++ b/doc.zih.tu-dresden.de/util/README.md @@ -0,0 +1,17 @@ +# Check scripts + +## check-no-floating.sh + +This script contains to checks. +It first checks the hierarchy depth of the file structure and +the second check tests if every markdown file is included in the navigation. + +### Usage + +```bash +./doc.zih.tu-dresden.de/utils/check-no-floating.sh doc.zih.tu-dresden.de +``` + +### Return codes + + * -1/255 if any error occure -- GitLab