Repository navigation
docs(site): publish the documentation on Read the Docs - #310
Merged
Merged
Conversation
saidsef
added
dependencies
Dependency ReviewThe following issues were found:
Vulnerabilitiesuv.lock
Only included vulnerabilities with severity high or higher. OpenSSF ScorecardScorecard details
Scanned Files
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 0 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
…ation The images override in the default kustomization was three list items where kustomize expects one, so it matched no image and dropped the tag. Changing newTag had no effect, and the tag pinned in the base Deployment always won. The override is now a single entry. - deployment/kustomization.yml joins name, newName and newTag into one item. - Rendered output stays the same at the current tag, and a different newTag now reaches the Deployment.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
saidsef
force-pushed
the
docs/read-the-docs
branch
from
October 16, 2026 23:51
62289db to
8b02fa4
Compare
The project's documentation was a handful of usage commands. Eight pages now cover how the model is trained, how to run and call the service, how to deploy and operate it, and what CI builds. - docs/README.md serves as the home page on GitHub and on the site. - Architecture opens with a diagram of the path from dataset to cluster. - Image tags, resource limits and other values that drift stay in the files that set them, and the pages link there. - Every link and anchor resolves, and nothing broke.
The documentation pages are now a Material-themed site that Read the Docs builds with MkDocs. Read the Docs installs the tooling from a docs dependency group in the uv lock file, which keeps it out of the image and lets Dependabot update it with everything else. - .readthedocs.yaml syncs the docs group with uv on Python 3.14. - pyproject.toml pins MkDocs, Material, pymdown-extensions and Pygments by major version. - mkdocs.yml runs in strict mode, so a broken link fails the build. - README.md links to the published site and carries its badge. - The site builds without warnings, and the image still installs only the runtime dependencies.
saidsef
force-pushed
the
docs/read-the-docs
branch
from
October 17, 2026 00:00
8b02fa4 to
48f22c7
Compare
Base automatically changed from
fix/kustomize-image-override
to
fix/default-port
October 19, 2026 08:39
saidsef
added a commit
that referenced
this pull request
Oct 19, 2026
* fix(api): report the predicted category's probability as the score The score in every classification response was the string "1". It came from comparing the article text with the predicted label, which never match. The handler now takes the class probabilities from the soft-voting ensemble and returns the highest one with its category. - classifier-ml.py picks the category from the model's classes at the highest probability, which agrees with predict. - Responses carry the score as a number between 0 and 1. - Classification returns the same categories as before, and nothing else broke. * fix(api): retrain the served model from the train endpoint The train endpoint never trained anything. Its payload indexing raised a KeyError that went back to the caller with a 200, and the fit would have run on a fresh classifier that served nothing. The endpoint now fits a copy of the served pipeline on 80% of the posted documents, scores it on the rest and swaps it in once the fit succeeds. - classifier.py clones the pipeline, so predictions never see a half-fitted model. - A lock turns a second request during a fit into a 409, since each fit holds another copy of the model in memory. - Malformed or undersized payloads get a 400 with the reason. - Training on 500 articles swaps the new model in while predictions keep serving, and nothing else broke. * fix(api): listen on port 7070 by default The service fell back to port 8080 when PORT was unset, while the image, the manifests and the probes all use 7070. A checkout started without PORT came up on the wrong port. The default now matches the rest of the project. - classifier-ml.py defaults PORT to 7070. - The comment above the setting goes, since it only restated the default. - With PORT unset the server listens on 7070, and nothing else broke. * fix(deployment): apply the image tag override in the default kustomization (#308) The images override in the default kustomization was three list items where kustomize expects one, so it matched no image and dropped the tag. Changing newTag had no effect, and the tag pinned in the base Deployment always won. The override is now a single entry. - deployment/kustomization.yml joins name, newName and newTag into one item. - Rendered output stays the same at the current tag, and a different newTag now reaches the Deployment. * docs(site): publish the documentation on Read the Docs (#310) * fix(deployment): apply the image tag override in the default kustomization The images override in the default kustomization was three list items where kustomize expects one, so it matched no image and dropped the tag. Changing newTag had no effect, and the tag pinned in the base Deployment always won. The override is now a single entry. - deployment/kustomization.yml joins name, newName and newTag into one item. - Rendered output stays the same at the current tag, and a different newTag now reaches the Deployment. * docs: add pages on training, running and deploying the classifier The project's documentation was a handful of usage commands. Eight pages now cover how the model is trained, how to run and call the service, how to deploy and operate it, and what CI builds. - docs/README.md serves as the home page on GitHub and on the site. - Architecture opens with a diagram of the path from dataset to cluster. - Image tags, resource limits and other values that drift stay in the files that set them, and the pages link there. - Every link and anchor resolves, and nothing broke. * docs(site): publish the documentation on Read the Docs The documentation pages are now a Material-themed site that Read the Docs builds with MkDocs. Read the Docs installs the tooling from a docs dependency group in the uv lock file, which keeps it out of the image and lets Dependabot update it with everything else. - .readthedocs.yaml syncs the docs group with uv on Python 3.14. - pyproject.toml pins MkDocs, Material, pymdown-extensions and Pygments by major version. - mkdocs.yml runs in strict mode, so a broken link fails the build. - README.md links to the published site and carries its badge. - The site builds without warnings, and the image still installs only the runtime dependencies.
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
Eight pages under
docs/cover training the model, running and calling the service, deploying and operating it on Kubernetes, and what CI builds. Read the Docs builds them into a Material site frommkdocs.yml, in strict mode.Related Issues
Fixes #304.
Changes Made
docsdependency group inuv.lock. The image and the notebook run never install it, and Dependabot's uv updates cover it.~=1.6pin holds MkDocs below 2.0, which removes the plugin system the theme relies on.docs/README.mddoubles as the site's home page, so GitHub and Read the Docs open on the same overview.Testing
uv run --only-group docs mkdocs build --strict- built, no warningswarn- no warningsuv export --frozen --no-dev- no MkDocs packagesChecklist