Skip to content

Commit

Permalink
Added starter pique info to static site
Browse files Browse the repository at this point in the history
  • Loading branch information
mollyiverson committed Jan 24, 2025
1 parent eee6ec5 commit 5273676
Show file tree
Hide file tree
Showing 5 changed files with 167 additions and 4 deletions.
37 changes: 34 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,33 @@
# Welcome to MkDocs
# Welcome to PIQUE

For full documentation visit [mkdocs.org](https://www.mkdocs.org).
## Overview

## Commands
The PIQUE Visualizer is a sophisticated React application designed to bring clarity and insight into software quality assessment. By visualizing PIQUE analysis results in a hierarchical tree display, it transforms complex JSON files into an intuitive and navigable interface. This tool is essential for developers, quality assurance professionals, and researchers who strive to understand and enhance software quality through detailed metrics and diagnostics.

## Purpose

Our mission with the PIQUE Visualizer is to simplify the interpretation of software quality results. We understand the challenges of parsing through dense JSON data. With this tool, users can easily navigate through quality scores, understand the impact of various factors on software quality, and make informed decisions to improve their projects.

## Significance

* Intuitive Visualization: Hierarchical tree displays make it easier to digest complex relationships and metrics.
* Efficient Analysis: Quickly identify key quality aspects and factors affecting your software project.
* Improved Decision Making: Visual insights aid in pinpointing areas for improvement and strategic planning.

## Target Audience

The PIQUE Visualizer is designed for:

* Software Developers: To assess and improve code quality.
* Quality Assurance Professionals: To visualize and interpret quality metrics.
* Research Scholars: Engaged in software quality research, looking for tools to aid in their analysis.

## Getting Started

Dive into using the PIQUE Visualizer by visiting our Getting Started page. You'll find detailed instructions on installation, setup, and prerequisites.


<!-- ## Commands
* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
Expand All @@ -15,3 +40,9 @@ For full documentation visit [mkdocs.org](https://www.mkdocs.org).
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
```python {annotate: true}
def hello_world():
# testing
print("Hello, World!")
``` -->
2 changes: 2 additions & 0 deletions docs/page2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

[Hover me](https://example.com "I'm a tooltip!")
Empty file added docs/test.md
Empty file.
Empty file added docs/test2.md
Empty file.
132 changes: 131 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,136 @@ markdown_extensions:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg


# Page tree
nav:
- Home: index.md
- Getting started:
- Testing: page2.md
- PIQUE-Lite:
- Testing: test.md
- PIQUE-Visualizer:
- Testing: test2.md
- Input File Schema Requirements:
- Testing: page2.md

# Page tree
# nav:
# - Home: index.md
# - Getting started:
# - Installation: getting-started.md
# - Creating your site: creating-your-site.md
# - Publishing your site: publishing-your-site.md
# - Customization: customization.md
# - Conventions: conventions.md
# - Browser support: browser-support.md
# - Enterprise feedback: enterprise-support.md
# - Philosophy: philosophy.md
# - Alternatives: alternatives.md
# - License: license.md
# - Tutorials:
# - tutorials/index.md
# - "Blogs":
# - tutorials/blogs/basic.md
# - tutorials/blogs/navigation.md
# - tutorials/blogs/engage.md
# - "Social cards":
# - tutorials/social/basic.md
# - tutorials/social/custom.md
# - Changelog:
# - changelog/index.md
# - How to upgrade: upgrade.md
# - Setup:
# - setup/index.md
# - Changing the colors: setup/changing-the-colors.md
# - Changing the fonts: setup/changing-the-fonts.md
# - Changing the language: setup/changing-the-language.md
# - Changing the logo and icons: setup/changing-the-logo-and-icons.md
# - Ensuring data privacy: setup/ensuring-data-privacy.md
# - Setting up navigation: setup/setting-up-navigation.md
# - Setting up site search: setup/setting-up-site-search.md
# - Setting up site analytics: setup/setting-up-site-analytics.md
# - Setting up social cards: setup/setting-up-social-cards.md
# - Setting up a blog: setup/setting-up-a-blog.md
# - Setting up tags: setup/setting-up-tags.md
# - Setting up versioning: setup/setting-up-versioning.md
# - Setting up the header: setup/setting-up-the-header.md
# - Setting up the footer: setup/setting-up-the-footer.md
# - Adding a git repository: setup/adding-a-git-repository.md
# - Adding a comment system: setup/adding-a-comment-system.md
# - Building an optimized site: setup/building-an-optimized-site.md
# - Building for offline usage: setup/building-for-offline-usage.md
# - Extensions:
# - setup/extensions/index.md
# - Python Markdown: setup/extensions/python-markdown.md
# - Python Markdown Extensions: setup/extensions/python-markdown-extensions.md
# - Plugins:
# - plugins/index.md
# - Blog: plugins/blog.md
# - Group: plugins/group.md
# - Info: plugins/info.md
# - Meta: plugins/meta.md
# - Offline: plugins/offline.md
# - Optimize: plugins/optimize.md
# - Privacy: plugins/privacy.md
# - Projects: plugins/projects.md
# - Search: plugins/search.md
# - Social: plugins/social.md
# - Tags: plugins/tags.md
# - Typeset: plugins/typeset.md
# - Requirements:
# - Image processing: plugins/requirements/image-processing.md
# - Caching: plugins/requirements/caching.md
# - Reference:
# - reference/index.md
# - Admonitions: reference/admonitions.md
# - Annotations: reference/annotations.md
# - Buttons: reference/buttons.md
# - Code blocks: reference/code-blocks.md
# - Content tabs: reference/content-tabs.md
# - Data tables: reference/data-tables.md
# - Diagrams: reference/diagrams.md
# - Footnotes: reference/footnotes.md
# - Formatting: reference/formatting.md
# - Grids: reference/grids.md
# - Icons, Emojis: reference/icons-emojis.md
# - Images: reference/images.md
# - Lists: reference/lists.md
# - Math: reference/math.md
# - Tooltips: reference/tooltips.md
# - Insiders:
# - insiders/index.md
# - Why sponsor us: insiders/why-sponsor-us.md
# - What's in it for you: insiders/benefits.md
# - Who is sponsoring: insiders/our-sponsors.md
# - Sponsoring tiers: insiders/sponsoring-tiers.md
# - How to sponsor: insiders/how-to-sponsor.md
# - Additional information:
# - Payment and billing: insiders/payment-and-billing.md
# - Access management: insiders/access-management.md
# - Runtime and cancellation: insiders/runtime-and-cancellation.md
# - Privacy: insiders/privacy.md
# - License: insiders/license.md
# - Support: support.md
# - Using Insiders:
# - Getting started: insiders/getting-started.md
# - Changelog:
# - insiders/changelog/index.md
# - How to upgrade: insiders/upgrade.md
# - Community:
# - Contributing:
# - contributing/index.md
# - Reporting a bug: contributing/reporting-a-bug.md
# - Reporting a docs issue: contributing/reporting-a-docs-issue.md
# - Requesting a change: contributing/requesting-a-change.md
# - Adding translations: contributing/adding-translations.md
# - Making a pull request: contributing/making-a-pull-request.md
# - Asking a question: https://github.com/squidfunk/mkdocs-material/discussions
# - Guides:
# - Creating a reproduction: guides/creating-a-reproduction.md
# - Community experts program:
# - insiders/community-experts-program/index.md
# - Blog:
# - blog/index.md

extra_css:
- docs-theme.css

0 comments on commit 5273676

Please sign in to comment.