Added basic empty pages for all sections, ready for content

MSUSEL · Jan 30, 2025 · 53dda76 · 53dda76
1 parent d57d840
commit 53dda76
Show file tree

Hide file tree

Showing 19 changed files with 89 additions and 11 deletions.
diff --git a/docs/developer-tools/getting-started.md → docs/developer-notes/getting-started.md b/docs/developer-tools/getting-started.md → docs/developer-notes/getting-started.md
diff --git a/docs/developer-notes/installation.md b/docs/developer-notes/installation.md
@@ -0,0 +1,14 @@
+This section is for people using this on their local machine.
+
+
+## Prerequisites
+
+[List of required software and dependencies.]
+
+## Installation Steps
+
+[Step-by-step instructions for installing and setting up PIQUE.]
+
+## First Steps
+
+[Basic commands to run PIQUE after installation.]
diff --git a/docs/developer-tools/system-requirements.md → docs/developer-notes/system-requirements.md b/docs/developer-tools/system-requirements.md → docs/developer-notes/system-requirements.md
diff --git a/docs/developer-tools/installation.md b/docs/developer-tools/installation.md
diff --git a/docs/faq-troubleshooting/common-issues.md b/docs/faq-troubleshooting/common-issues.md
@@ -0,0 +1,3 @@
+
+## JSON Input Errors
+[Common issues and how to resolve them.]
diff --git a/docs/faq-troubleshooting/faq.md b/docs/faq-troubleshooting/faq.md
@@ -0,0 +1 @@
+[Common questions]
diff --git a/docs/faq.md b/docs/faq.md
diff --git a/docs/glossary.md b/docs/glossary.md
@@ -0,0 +1,3 @@
+## Key Terms and Abbreviations
+
+[Definitions of important terms.]
diff --git a/docs/overview/introduction.md b/docs/overview/introduction.md
@@ -0,0 +1,15 @@
+## 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.]
diff --git a/docs/tutorials/adv-example.md b/docs/tutorials/adv-example.md
@@ -0,0 +1,3 @@
+## Advanced Example
+
+[More complex use case walkthrough.]
diff --git a/docs/tutorials/advanced-example.md b/docs/tutorials/advanced-example.md
diff --git a/docs/tutorials/basic-example.md b/docs/tutorials/basic-example.md
@@ -0,0 +1,3 @@
+## Basic Example
+
+[Walkthrough using a sample input file.]
diff --git a/docs/user-guide/advanced-features/adv-features.md b/docs/user-guide/advanced-features/adv-features.md
@@ -0,0 +1,15 @@
+## Hierarchical Tree Display
+
+[Explanation of this visualization.]
+
+## Adjusting Weights
+
+[How to modify contributions, sensitivity, and impact.]
+
+## Importing/Exporting Weight Adjustments
+
+[Instructions on saving and reusing configurations.]
+
+## Interpreting Results
+
+[Reference to glossary for deeper understanding.]
diff --git a/docs/user-guide/advanced-features/adv.md b/docs/user-guide/advanced-features/adv.md
diff --git a/docs/user-guide/core-features/core-features.md b/docs/user-guide/core-features/core-features.md
@@ -0,0 +1,11 @@
+## File Upload
+
+[How to upload files, referencing the FAQ for common issues.]
+
+## Initial Display
+
+[Overview of TQI, selecting projects, zooming into a time frame.]
+
+## Interpreting Visualizations and Metrics
+
+[Guidelines on how to read the output.]
diff --git a/docs/user-guide/core-features/core.md b/docs/user-guide/core-features/core.md
diff --git a/docs/user-guide/input-schema/input-schema.md b/docs/user-guide/input-schema/input-schema.md
@@ -0,0 +1,11 @@
+## General Dataset Structure
+
+[Overview of expected input format.]
+
+## Factors, Measures, Diagnostics
+
+[Explanation of key elements in input files.]
+
+## Compatibility and JSON Validation
+
+[Notes on ensuring valid input files.]
diff --git a/docs/user-guide/input-schema/input.md b/docs/user-guide/input-schema/input.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,21 +75,20 @@ nav:
   - Overview:
     - Introduction: overview/introduction.md
     - Quick Start: overview/quick-start.md
-  - Developer Tools:
-    - System Requirements: developer-tools/system-requirements.md
-    - Installation: developer-tools/installation.md
+  - Developer Notes:
+    - Getting Started: developer-notes/getting-started.md
+    - Installation: developer-notes/installation.md
   - User Guide: 
-    - "Input Schema":
-      - test: user-guide/input-schema/input.md
-    - "Core Features":
-      - test: user-guide/core-features/core.md
-    - "Advanced Features":
-      - test: user-guide/advanced-features/adv.md
+    - Input Schema: user-guide/input-schema/input-schema.md
+    - Core Features: user-guide/core-features/core-features.md
+    - Advanced Features: user-guide/advanced-features/adv-features.md
   - Tutorials:
     - Basic Example: tutorials/basic-example.md
-    - Advanced Example: tutorials/advanced-example.md
+    - Advanced Example: tutorials/adv-example.md
   - Glossary: glossary.md
-  - FAQ: faq.md
+  - FAQ and Troubleshooting: 
+    - Frequently Asked Questions: faq-troubleshooting/faq.md
+    - Common Issues: faq-troubleshooting/common-issues.md
 
 extra_css:
   - assets/docs-theme.css
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@

		## JSON Input Errors
		[Common issues and how to resolve them.]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Key Terms and Abbreviations

		[Definitions of important terms.]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Advanced Example

		[More complex use case walkthrough.]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Basic Example

		[Walkthrough using a sample input file.]