Egothor/Radixor
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: refine footer branding and improve Javadoc overview

Browse Source 
- remove Material for MkDocs generator branding from the site footer
- keep footer presentation aligned with the project's professional documentation style
- improve Javadoc overview content for the API landing page
- align Javadoc introductory text with the main project site messaging
- clarify project scope, documentation purpose, and license information
This commit is contained in:
Leo Galambos
2026-04-18 15:04:37 +02:00
parent 1df6c0c87e
commit db446932fc
3 changed files with 68 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
build.gradle
View File

@@ -309,6 +309,17 @@ javadoc {
options.version = true options.version = true
options.windowTitle = 'Radixor - Egothor Stemmer' options.windowTitle = 'Radixor - Egothor Stemmer'
options.docTitle = 'Radixor - Egothor Stemmer API' options.docTitle = 'Radixor - Egothor Stemmer API'
options.overview = file('src/main/javadoc/overview.html')
options.bottom = """
<div class="legal-copy">
&copy; 2026 Egothor
<br/>
Licensed under <a href="https://github.com/leogalambos/Radixor/blob/main/LICENSE">BSD-3-Clause</a>
</div>
"""
options.links('https://docs.oracle.com/en/java/javase/21/docs/api/')
options.group('Core Stemming API', 'org.egothor.stemmer')
options.group('Trie Infrastructure', 'org.egothor.stemmer.trie')
source = sourceSets.main.allJava source = sourceSets.main.allJava
} }

5
mkdocs.yml
View File

@@ -3,7 +3,7 @@ site_description: High-performance multi-language stemming toolkit for Java
site_url: https://leogalambos.github.io/Radixor/ site_url: https://leogalambos.github.io/Radixor/
repo_url: https://github.com/leogalambos/Radixor repo_url: https://github.com/leogalambos/Radixor
repo_name: leogalambos/Radixor repo_name: leogalambos/Radixor
copyright: "&copy; ${year} Egothor. Licensed under <a href='https://github.com/leogalambos/Radixor/blob/main/LICENSE'>BSD-3-Clause</a>." copyright: "&copy; 2026 Egothor. Licensed under <a href='https://github.com/leogalambos/Radixor/blob/main/LICENSE'>BSD-3-Clause</a>."
theme: theme:
name: material name: material
@@ -20,6 +20,9 @@ theme:
primary: indigo primary: indigo
accent: indigo accent: indigo
extra:
generator: false
markdown_extensions: markdown_extensions:
- admonition - admonition
- attr_list - attr_list

53
src/main/javadoc/overview.html Normal file
View File

@@ -0,0 +1,53 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Radixor Overview</title>
</head>
<body>
<h1>Radixor</h1>
<p>
Radixor is a high-performance Java toolkit for dictionary-driven stemming based on
the proven Egothor patch-command trie approach. It is designed for production-grade
search and text-processing systems that require deterministic behavior, efficient
runtime execution, and maintainable lexical assets.
</p>
<p>
In addition to compiling and executing stemming dictionaries, Radixor extends the
traditional Egothor model with support for evolving compiled dictionary artifacts
through additional transformation layers. This allows existing lexical resources to
be refined incrementally without requiring full recompilation from source dictionaries.
</p>
<h2>Project Scope</h2>
<ul>
<li>Compilation of Egothor-compatible stemming dictionaries</li>
<li>Runtime stemming over compact compiled trie artifacts</li>
<li>Transformation and reduction infrastructure for lexical processing</li>
<li>CLI and programmatic integration for Java 21 and newer</li>
</ul>
<h2>API Documentation</h2>
<p>
This Javadoc site documents the Java API of the project. For usage guidance,
architectural context, benchmarking methodology, published reports, and general
project documentation, refer to the main project site:
<a href="https://leogalambos.github.io/Radixor/">leogalambos.github.io/Radixor</a>.
</p>
<h2>License</h2>
<p>
Radixor is distributed under the
<a href="https://github.com/leogalambos/Radixor/blob/main/LICENSE">BSD-3-Clause License</a>.
</p>
<h2>Packages</h2>
<p>
The main API is located in <code>org.egothor.stemmer</code>. Supporting trie-oriented
structures and related implementation components are located in
<code>org.egothor.stemmer.trie</code>.
</p>
</body>
</html>