Usage Guide

The CrOSSD web interface is designed to support clear navigation and transparent access to project metrics. It enables users to monitor and evaluate the health of open-source projects through structured data presentation and accessible documentation.

Homepage

The CrOSSD web interface opens on a structured and user-friendly homepage. This page provides direct access to the project search function and presents general statistics about the indexed data, offering a concise overview of the platform.

Project Search

The search function enables users to locate projects using specific keywords. After entering a term, a list of matching projects is displayed, supporting efficient navigation and quick access to relevant results.

Project Overview

Overview

When a project is selected, the Overview tab shows a selected set of important metrics and a visual representation. A dropdown menu allows users to switch between different scan instances, making it possible to compare results over time.

Details

The Details tab displays a grouped list of its current health metrics based on the most recent scan. It also provides a historical view of the metrics, allowing users to analyze trends and developments over time.

AI Assessment

The AI Assessment tab provides an AI-generated evaluation of the project’s health, based on the collected data. Due to resource constraints, this feature is currently only available for a limited number of projects.

Metric Details

Selecting an individual metric opens a detailed view with its description and definition. This view also includes graphical representations of the metric’s historical values across all scan instances, allowing users to analyze trends and developments.

Groups

Group Selection

The webinterface also displays groups of repositories, defined by the project team.

Group Details

The group detail page shows the repositories in the group and their health status. The metrics are calculated as the average, minimum, maximum, aggregation and standard deviation of all repositories in the group.

Documentation and Resources

The interface provides dedicated sections for documentation and project-related information. These can be accessed via the navigation bar and footer, offering guidance and additional resources for using the platform effectively.