Repository navigation
docs: refine documentation tone, eliminate ai artifacts, and expand technical depth - #25
Merged
Merged
Conversation
…ross guides and API reference
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/index.md) to reflect the published ECML PKDD 2026 paper, Springer chapter citation, NCN grant funding, and three-layer synchronous processing architecture.docs/api/with module architectural overviews, key class/function matrices, and standard import workflows preceding the autogeneratedmkdocstringsdirectives.Motivation
Following pull request #22 which established the MkDocs infrastructure and autogenerated API reference, the documentation retained visible signs of AI-generated content (excessive emojis in headings, shallow 30-line skeleton pages, formulaic bullet lists, and conversational filler). Drawing inspiration from the evolution of
README.md—which transitioned from an emoji-heavy draft to a rigorous, academic presentation for ECML PKDD 2026—this PR elevates the documentation to match the project's peer-reviewed research caliber.Key Changes
1. Landing Page & Quickstart
🌟 Overview,🏛️ Architecture,🚀 Quick Navigation) and centered HTML banner indocs/index.mdwith an academic header, publication badges, formal problem decomposition, three-layer architectural narrative, and clean navigation tables.docs/getting-started/quickstart.mdto present a cohesive, realistic end-to-end stream forensics workflow (Hyperplane drift generationdocs/getting-started/installation.mdwith explicit virtual environment setup and a detailed capability extras table.2. Analytical User Guides
docs/user-guide/data-layer.md): Added formal mathematical formulations for Kolmogorov-Smirnov (docs/user-guide/model-layer.md): Detailed River's DDM Bernoulli process formulation (DriftDescriptiondataclass schema.docs/user-guide/boundary-analysis.md): Explained why standard dimensionality reduction lacks continuous inverse mapping (docs/user-guide/feature-importance.md): Formalized the temporal discriminator paradigm, explained the distinction between data drift (docs/user-guide/clustering-dynamics.md): Documented dynamicdocs/user-guide/recurring-concepts.md): Formalized prototype tree representations (ProTree), pairwise distance matrices ("minimal_distance","mean_distance"), and HDBSCAN regime clustering with outlier correction.docs/user-guide/dashboard.md): Detailed the decoupled architecture, session state isolation, computation gating, full tab-by-tab workflow, and Shaker dataset stitcher dialog.3. Theory & Developer Standards
docs/theory/drift-taxonomy.md): Formalized Bayesian decompositiondocs/theory/mathematical-formulations.md): Comprehensive mathematical reference including Kantorovich-Rubinstein duality, asymptotic ECDF distributions, SSNP loss formulation, and conformal prediction guarantees.docs/developer/): Outlined architectural invariants (pure core, headless plotting), Git conventional commit protocols, and codified Google-style docstring invariants with type deduplication rules.4. API Reference Manuals
api/datasets.md,api/drift.md,api/exceptions.md,api/models.md,api/plotting.md,api/xai-boundary.md,api/xai-clustering.md,api/xai-importance.md,api/xai-recurrence.md,api/xai-stats.md) with module architectural contexts and summary tables of exported classes, exceptions, and methods.Verification
ruff check .passed with 0 errors (All checks passed!)ruff format --check .passed cleanly with 0 formatting warnings (113 files already formatted)python -m unittest discover testspassed with 42/42 tests passing (OK)mkdocs build --strictbuilt documentation with 0 warnings or errors in strict modedocs/