Publish a documentation site, an English README, and Dependabot - #1
Merged
Conversation
praxis was the odd one out: mlango, decisionrl and glia each have a built documentation site, and praxis had four Markdown files reachable only by browsing the repository. Its README was Russian-only while the organisation reads English first, so an international visitor had no entry point at all. Adds a mkdocs-material site on the same setup as the other projects, Russian by default because the subject is Russian law and the reference pages quote it directly, with an English overview and fallback for the rest. The docs workflow runs mkdocs build --strict on pull requests too, so a broken internal link fails review rather than reaching a reader. Adds README.en.md as a full mirror of the Russian README, and the language line both READMEs were missing. Adds .github/dependabot.yml: weekly grouped action updates, dev tooling grouped, runtime dependencies in their own pull requests. Retrieval models are pinned deliberately -- they move when someone re-runs the golden set, not on a schedule -- so torch, transformers, sentence-transformers and FlagEmbedding are ignored. The Python client link in docs/API.md pointed at ../clients/, which resolves in the repository but not on a published site; it is now absolute. The glia and mlango references now name the organisation rather than a personal account, since both libraries live here. Site verified locally: mkdocs build --strict passes for both locales.
DenisDrobyshev
force-pushed
the
docs/site-and-english-readme
branch
from
August 4, 2026 20:14
1953b94 to
09d6d18
Compare
DenisDrobyshev
added a commit
that referenced
this pull request
Aug 5, 2026
PR #1 has been open since 3 August with that file, alongside the docs site and the English README. Duplicating it here would have made whichever merged second a conflict.
4 tasks
DenisDrobyshev
added a commit
that referenced
this pull request
Aug 6, 2026
* Bring CI up to the standard the other repositories already meet praxis had the thinnest pipeline in the organisation: one job, one Python version, one operating system, and actions two major versions behind. The package claims 3.11 through 3.13 and ships three console scripts, none of which anything verified. - test matrix across 3.11-3.13, plus macOS and Windows on 3.12 - a build job that installs the wheel into a clean environment and runs every console script, because an editable install hides a module missing from the wheel - an aggregate `CI` job, so branch protection has one check to require and adding a matrix entry cannot silently leave it unguarded - CodeQL weekly and on every push - Dependabot for pip and actions, with the ml extra left pinned - pre-commit, including ruff-format `ruff format --check` is deliberately absent from CI: nineteen files predate the formatter, so the gate would be red on day one. pre-commit formats what a commit touches until that is fixed in its own change. * Leave dependabot.yml to the pull request that already adds it PR #1 has been open since 3 August with that file, alongside the docs site and the English README. Duplicating it here would have made whichever merged second a conflict.
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
1 participant
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.
praxis was the odd one out: mlango, decisionrl and glia each publish a documentation site; praxis had four Markdown files reachable only by browsing the repository, and a Russian-only README while the organisation reads English first.
What this adds
A documentation site on the same mkdocs-material setup as the other projects, at
https://drobyshevdev.github.io/praxis/. Russian is the default locale because the subject is Russian law and the reference pages quote it directly; the overview exists in English and the rest falls back rather than disappearing from the navigation.README.en.md— a full mirror of the Russian README, plus the language line both READMEs were missing..github/dependabot.yml— weekly grouped action updates, dev tooling grouped, runtime dependencies in their own pull requests.torch,transformers,sentence-transformersandFlagEmbeddingare ignored on purpose: retrieval quality is pinned to specific model versions and measured on the golden set, so those move when someone re-runs the eval, not on a schedule.Two link fixes.
docs/API.mdpointed the Python client at../clients/..., which resolves in the repository but not on a published site. The glia and mlango references named a personal account; both libraries are in the organisation now.Verification
mkdocs build --strictpasses locally for both locales — 4 navigation elements translated, no broken internal links. The docs workflow runs the same strict build on pull requests, so this check does not only exist onmain.Note
homepageon the repository still points at/releases/latest; it moves to the docs site once this is merged and the first deploy lands.🤖 Generated with Claude Code