feat: add MkDocs Material site and publish docs + CI reports to GitHub Pages

This commit is contained in:
2026-04-18 02:14:45 +02:00
parent 59128edc42
commit bc031f2d8b
13 changed files with 158 additions and 75 deletions

View File

@@ -1,7 +1,5 @@
# Architecture and Reduction
> ← Back to [README.md](../README.md)
This document describes the internal architecture of **Radixor** and the principles behind its **trie compilation and reduction model**.
It explains:

View File

@@ -1,7 +1,5 @@
# Benchmarking
> ← Back to [README.md](../README.md)
Radixor includes a JMH benchmark suite for both the internal algorithmic core and a side-by-side English comparison against the Snowball Porter stemmer family.
This document explains what is benchmarked, how to run it, and how to interpret the results responsibly.

View File

@@ -1,7 +1,5 @@
# Built-in Languages
> ← Back to [README.md](../README.md)
Radixor provides a set of **bundled stemmer dictionaries** that can be loaded directly without preparing custom data.
These built-in resources are useful for:

View File

@@ -1,7 +1,5 @@
# CLI Compilation
> ← Back to [README.md](../README.md)
Radixor provides a command-line tool for compiling dictionary files into compact, production-ready binary stemmer tables.
This is the recommended workflow for deployment environments, as it separates:

View File

@@ -1,7 +1,5 @@
# Dictionary Format
> ← Back to [README.md](../README.md)
Radixor uses a simple, line-oriented dictionary format to define mappings between **word forms** and their **canonical stems**.
This format is intentionally minimal, language-agnostic, and easy to generate from existing linguistic resources or corpora.

20
docs/index.md Normal file
View File

@@ -0,0 +1,20 @@
# Radixor
**Radixor** is a high-performance, multi-language stemmer for Java, designed for production-grade search and text-processing systems.
It modernizes the proven Egothor patch-command trie approach and delivers:
- **Fast runtime stemming** with compact lookup structures
- **Multi-language adaptability** through dictionary-driven compilation
- **Deterministic behavior** suitable for reproducible processing pipelines
- **Flexible integration paths**, including CLI-based and programmatic workflows
- **Operational transparency** via continuously published quality and benchmark reports
Radixor is built for teams that need consistent stemming quality at scale without sacrificing maintainability or deployment efficiency.
## Start here
- Read [Quick Start](quick-start.md) for immediate implementation guidance.
- Use [Programmatic Usage](programmatic-usage.md) for application integration patterns.
- Review [Benchmarking](benchmarking.md) for reproducible performance methodology.
- Open [CI Reports](reports.md) to inspect published build artifacts and quality metrics.

View File

@@ -1,7 +1,5 @@
# Programmatic Usage
> ← Back to [README.md](../README.md)
This document describes how to use **Radixor** programmatically from Java.
It covers:

View File

@@ -1,7 +1,5 @@
# Quality and Operations
> ← Back to [README.md](../README.md)
This document describes quality, testing, and operational practices for **Radixor**.
It focuses on:

View File

@@ -1,7 +1,5 @@
# Quick Start
> ← Back to [README.md](../README.md)
This guide shows the fastest way to start using **Radixor** and the most common next steps.
## Hello world

27
docs/reports.md Normal file
View File

@@ -0,0 +1,27 @@
# CI Reports
Radixor publishes durable CI artifacts to GitHub Pages on every qualifying run of `.github/workflows/pages.yml`.
## Primary report entry points
- [Latest build summary](../builds/latest/)
- [Javadoc](../builds/latest/javadoc/)
- [Unit test report](../builds/latest/test/)
- [PMD report](../builds/latest/pmd/main.html)
- [JaCoCo coverage report](../builds/latest/coverage/)
- [PIT mutation testing report](../builds/latest/pitest/)
- [Dependency vulnerability report](../builds/latest/dependency-check/dependency-check-report.html)
- [SBOM (JSON)](../builds/latest/sbom/radixor-sbom.json)
- [SBOM (XML)](../builds/latest/sbom/radixor-sbom.xml)
## Benchmark and badge metadata
- [JMH benchmark results (TXT)](../builds/latest/jmh/jmh-results.txt)
- [JMH benchmark results (CSV)](../builds/latest/jmh/jmh-results.csv)
- [Coverage badge metadata](../builds/latest/metrics/coverage-badge.json)
- [Mutation badge metadata](../builds/latest/metrics/pitest-badge.json)
- [Benchmark badge metadata](../builds/latest/metrics/jmh-badge.json)
## Historical runs
- [Browse historical build reports](../builds/)