diff --git a/docs/assets/docs-theme.css b/docs/assets/docs-theme.css index 3291c93d..bbd5af02 100644 --- 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 index 027ed923..1acccb38 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,2 +1,25 @@ -# Welcome to PIQUE + +## 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. + +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. \ No newline at end of file diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md deleted file mode 100644 index 48283675..00000000 --- a/docs/overview/introduction.md +++ /dev/null @@ -1,15 +0,0 @@ -## What is PIQUE? - -[Brief description of PIQUE.] - -## Significance of Analyzing Software Quality - -[Why software quality matters and how PIQUE helps.] - -## Unified Purpose - -[Combining simplified views for project managers (PIQUE-Lite) with advanced analytics for developers/researchers (PIQUE Visualizer).] - -## High-Level Use Cases - -[Examples of when and why users would use PIQUE.] \ No newline at end of file diff --git a/docs/overview/quick-start.md b/docs/overview/quick-start.md deleted file mode 100644 index e69de29b..00000000 diff --git a/mkdocs.yml b/mkdocs.yml index e0dd9bff..e657ba24 100644 --- 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