From fdec0ea4d54e881ec843ba0698693d2ae6daa1d2 Mon Sep 17 00:00:00 2001
From: selva <selva.g@subcom.tech>
Date: Tue, 22 Nov 2022 16:45:48 +0530
Subject: [PATCH] docs: add table of contents
---
docs/source/getting_started/Installation.md | 2 ++
docs/source/getting_started/Working.md | 11 +++++++++++
.../source/getting_started/commands/bitia_checksum.md | 2 +-
docs/source/index.md | 4 ++--
4 files changed, 16 insertions(+), 3 deletions(-)
diff --git a/docs/source/getting_started/Installation.md b/docs/source/getting_started/Installation.md
index 8adfc4c..866738b 100644
--- a/docs/source/getting_started/Installation.md
+++ b/docs/source/getting_started/Installation.md
@@ -10,6 +10,8 @@ BiTIA CLI is available on [PyPi] as [BiTIA].
Installing bitia is very simple. You only need to have [python-pip] installed in your system.
+***
+
To Install **BiTIA** using pip, run this command:
diff --git a/docs/source/getting_started/Working.md b/docs/source/getting_started/Working.md
index 860ac36..750fbd3 100644
--- a/docs/source/getting_started/Working.md
+++ b/docs/source/getting_started/Working.md
@@ -30,6 +30,17 @@ To list available commands and options in bitia, execute `bitia --help`
</div>
+```{toctree}
+:hidden:
+
+commands/bitia_checksum
+commands/bitia_logs
+commands/bitia_create_container
+commands/bitia_list_container
+commands/bitia_run
+commands/bitia_submit
+```
+
## Commands
<div style="float:left">
diff --git a/docs/source/getting_started/commands/bitia_checksum.md b/docs/source/getting_started/commands/bitia_checksum.md
index 64aebbe..54e6786 100644
--- a/docs/source/getting_started/commands/bitia_checksum.md
+++ b/docs/source/getting_started/commands/bitia_checksum.md
@@ -44,6 +44,6 @@ value that represents the number of bits in a transmission message
</div>
-<script type="text/javascript" src="../../_static/js/termynal.js" data-termynal-container="#termynal|#termynal1"></script>
+<script type="text/javascript" src="https://raw.githack.com/Ganz1285/terminal/main/termynal.js" data-termynal-container="#termynal|#termynal1"></script>
diff --git a/docs/source/index.md b/docs/source/index.md
index 554436b..8c2a49f 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -30,14 +30,14 @@ BiTIA has two components: **bitia-cli** and **bitia-runner**.
BiTIA CLI is on the client side and allows clients to submit tasks to the bitia server.
BiTIA runner is on the server side and operates the given tasks to produce results.
-## **bitia-cli**
+## BiTIA CLI
Most users only need the `bitia-cli` tool to submit tasks.
BiTIA CLI creates a zip file of the user input(pipeline) containing a unique hash and ships it to the server.
[see some examples]: examples
```{toctree}
-:hidden: true
+:hidden:
getting_started/Installation
getting_started/Working
--
GitLab