diff --git a/build.gradle b/build.gradle index 5dbd367..992b64a 100644 --- a/build.gradle +++ b/build.gradle @@ -309,6 +309,17 @@ javadoc { options.version = true options.windowTitle = 'Radixor - Egothor Stemmer' options.docTitle = 'Radixor - Egothor Stemmer API' + options.overview = file('src/main/javadoc/overview.html') + options.bottom = """ + + """ + 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 } diff --git a/mkdocs.yml b/mkdocs.yml index 8077180..b2b6909 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,7 @@ site_description: High-performance multi-language stemming toolkit for Java site_url: https://leogalambos.github.io/Radixor/ repo_url: https://github.com/leogalambos/Radixor repo_name: leogalambos/Radixor -copyright: "© ${year} Egothor. Licensed under BSD-3-Clause." +copyright: "© 2026 Egothor. Licensed under BSD-3-Clause." theme: name: material @@ -20,6 +20,9 @@ theme: primary: indigo accent: indigo +extra: + generator: false + markdown_extensions: - admonition - attr_list diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html new file mode 100644 index 0000000..21997f1 --- /dev/null +++ b/src/main/javadoc/overview.html @@ -0,0 +1,53 @@ + + + + + Radixor Overview + + +

Radixor

+ +

+ 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. +

+ +

+ 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. +

+ +

Project Scope

+ + +

API Documentation

+

+ 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: + leogalambos.github.io/Radixor. +

+ +

License

+

+ Radixor is distributed under the + BSD-3-Clause License. +

+ +

Packages

+

+ The main API is located in org.egothor.stemmer. Supporting trie-oriented + structures and related implementation components are located in + org.egothor.stemmer.trie. +

+ + \ No newline at end of file