From 200425c88399a0c4135985de033f3fd838896d67 Mon Sep 17 00:00:00 2001
From: Jesus Camacho Rodriguez <jesusca@microsoft.com>
Date: Mon, 12 Feb 2024 16:47:59 -0800
Subject: [PATCH] Including documentation

---
 metrics/app/README.md | 31 +++++++++++++++++++++++++++++++
 metrics/app/main.py   |  2 +-
 run/README.md         | 19 +++++++++++++++++++
 3 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 metrics/app/README.md
 create mode 100644 run/README.md

diff --git a/metrics/app/README.md b/metrics/app/README.md
new file mode 100644
index 00000000..c199b9f0
--- /dev/null
+++ b/metrics/app/README.md
@@ -0,0 +1,31 @@
+<!--
+{% comment %}
+Copyright (c) Microsoft Corporation.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
+# LST-Bench: Dashboard
+
+**Dashboard:** [https://lst-bench.azurewebsites.net/](https://lst-bench.azurewebsites.net/)
+
+The LST-Bench dashboard is powered by [Streamlit](https://github.com/streamlit/streamlit) and deployed to Azure App Service through GitHub actions. 
+You can find the deployment workflow [here](../../.github/workflows/webapp-deploy.yaml). 
+The dashboard provides insights derived from metrics collected from LST-Bench, including execution time and degradation rate. 
+Further details about the runs and setups are available [here](../../run).
+
+## Adding a New Result
+To include data from a new system, duplicate one of the directories in the [run folder](../../run) and modify the necessary files within. 
+For a deeper understanding of the directory structure, consult the [README file](../../run/README.md). 
+The LST-Bench dashboard web app automatically retrieves results from the .duckdb files within those folders and displays them on the dashboard.
diff --git a/metrics/app/main.py b/metrics/app/main.py
index 7dd1165e..d5b530ac 100644
--- a/metrics/app/main.py
+++ b/metrics/app/main.py
@@ -233,7 +233,7 @@ def get_experiments_data(experiments_df: pd.DataFrame, target_granularity: str)
 st.title('LST-Bench - Dashboard')
 st.write("[Project Page](https://github.com/microsoft/lst-bench/) | "
          "[Technical Report](https://arxiv.org/abs/2305.01120) | "
-         "Add a System")
+         "[Add a System](https://github.com/microsoft/lst-bench/tree/main/metrics/app#adding-a-new-result)")
 
 workloads = get_workloads()
 workload_selected = st.sidebar.selectbox('Workload', workloads, index=0)
diff --git a/run/README.md b/run/README.md
new file mode 100644
index 00000000..cc161ad6
--- /dev/null
+++ b/run/README.md
@@ -0,0 +1,19 @@
+<!--
+{% comment %}
+Copyright (c) Microsoft Corporation.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+{% endcomment %}
+-->
+
+# TODO
\ No newline at end of file