Added home screen

MSUSEL · Feb 4, 2025 · c675a97 · c675a97
1 parent a4d8ac1
commit c675a97
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 20 deletions.
diff --git a/docs/assets/docs-theme.css b/docs/assets/docs-theme.css
@@ -16,4 +16,12 @@
   margin-left: auto;
   margin-right: auto;
   width: 100%;
+  box-shadow: 0 0 2px black;
+}
+
+.small-img {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+  width: 70%;
 }
diff --git a/docs/index.md b/docs/index.md
@@ -1,2 +1,25 @@
-# Welcome to PIQUE
+<img src="https://raw.githubusercontent.com/MSUSEL/msusel-pique-visualizer/refactorZiyi/src/assets/PIQUE_svg.svg" class="small-img">
 
+## Introduction
+**PIQUE** (Platform for Investigative software Quality Understanding and Evaluation) is a tool designed to help developers, security analysts, and project managers assess and track the security quality of software. By collecting and displaying findings from multiple security analysis tools, PIQUE provides a clear, intuitive way to evaluate software quality.
+
+<img src="assets/images/characteristics.png" class="medium-img" alt="PIQUE project quality comparison">
+
+## Key Features
+- **Visualize Software Quality Over Time** – Track how security scores change across different software versions and dates
+- **Explore a Hierarchical Breakdown of Security Metrics** – Understand software quality through an interactive tree-based representation
+- **Compare Quality Across Categories** – Assess security across multiple aspects, including Availability, Authenticity, Authorization, Confidentiality, Non-repudiation, and Integrity
+- **Prioritize Areas for Improvement** – Identify high-risk areas in the software that require immediate attention
+
+## Who is PIQUE for?
+PIQUE is designed to support multiple stakeholders:
+
+- **Developers** can analyze security risks in their software and track improvements over time
+- **Security Analysts/Researchers** gain insights from multiple security tools to assess vulnerabilities more effectively
+- **Project Managers** can review high-level security trends and make informed decisions without deep technical knowledge
+
+## Customization and Advanced Features
+PIQUE allows users to customize quality assessments to fit their needs. Users can adjust the weights of the six core quality aspects: Availability, Authenticity, Authorization, Confidentiality, Non-repudiation, and Integrity. This gives stakeholders control over how security scores are calculated so evaluations match their priorities and risk tolerance.
+
+## Next Steps
+The [User Guide](user-guide/index.md) will walk you through how to interact with PIQUE’s features, interpret results, and make informed decisions based on security quality assessments.
diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md
diff --git a/docs/overview/quick-start.md b/docs/overview/quick-start.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,10 +75,7 @@ markdown_extensions:
 
 # Page tree
 nav:
-  - Home: index.md
-  - Overview:
-    - Introduction: overview/introduction.md
-    - Quick Start: overview/quick-start.md
+  - PIQUE: index.md
   - Developer Notes: developer-notes/setup.md
   - User Guide:
     - Overview: user-guide/index.md