docs: publish model accuracy report via mkdocs from main#975
Merged
Conversation
Move the reports/ folder (model_accuracy_report.html, download_report.py, README.md) from the gh-pages branch into docs/reports/ on main so the report is version-controlled and published by the docs workflow instead of being hand-edited on gh-pages. - mkdocs publishes the HTML as a versioned static asset; download_report.py and README.md are excluded from the built site via exclude_docs. - supported-models.md links to the report with a source-relative path so it resolves within each docs version. - Bump the report's displayed version: WinML CLI 0.1.0 -> 0.2.0. - Update download_report.py/README prose for the new PR-based refresh flow. - Add a ruff per-file-ignore for the relocated download script. - check-yaml: add --unsafe so mkdocs.yml custom tags don't block commits.
timenick
approved these changes
Jun 25, 2026
KayMKM
added a commit
that referenced
this pull request
Jun 25, 2026
…orts/ (#976) ## Summary Fixes the published `0.2` docs version and cleans up the now-redundant top-level `reports/` folder on `gh-pages`. After #975 merged, the push-to-main docs deploy only refreshed the **dev** version. The released **0.2** version was left stale: its supported-models page still linked to the old top-level report, and `0.2/reports/` had no report file. This mirrors the dev result into `0.2` and removes the old top-level `reports/` folder (superseded by the per-version `docs/reports/` now published under each docs version). ## Changes - **Add** `0.2/reports/model_accuracy_report.html` — copied verbatim from the freshly deployed `dev` build (WinML CLI **0.2.0**). - **0.2/reference/supported-models/index.html** — update the report link from the old absolute `.../reports/model_compatibility_report.html` to the version-relative `../../reports/model_accuracy_report.html` ("Model Accuracy Report"). - **0.2/search/search_index.json** — update the matching link text `model compatibility report` → `Model Accuracy Report` (single-phrase change in the minified index) so search results stay consistent with the page. - **Remove** the top-level `reports/` folder (`README.md`, `download_report.py`, `model_accuracy_report.html` — the stale 0.1.0 copy). ## Verification - `0.2/reports/` contains only the HTML; the report displays **WinML CLI 0.2.0**. - The `0.2` supported-models link and search index now match the `dev` version exactly. - Top-level `reports/` is fully removed; the report remains available per-version at `.../<version>/reports/model_accuracy_report.html`. - `search_index.json` remains valid JSON (net −5 chars, single phrase replaced). ## Notes - Edited the built site directly (the standard way to patch an already-released `mike` version) rather than re-running `mike deploy`, which on a Windows runner rewrites file modes across all ~93 pages of `0.2/` and would bury this 2-file change in noise.
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
2 participants
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
Moves the model accuracy report out of the hand-maintained
gh-pagesbranch and intomainunderdocs/reports/, so it is version-controlled and published by the docs workflow (option C). Also fixes the report's displayed WinML CLI version (0.1.0→0.2.0).Previously
reports/lived only ongh-pagesand was edited directly on the built site, so source and published content drifted and manual edits were overwritten on the nextmike deploy. Releases are infrequent, so the extra per-version copy of the report is an acceptable tradeoff.Changes
reports/→docs/reports/(model_accuracy_report.html,download_report.py,README.md).download_report.pyandREADME.mdfrom the built site viaexclude_docs; only the HTML is published (as a versioned static asset).../reports/model_accuracy_report.html) so it resolves within each docs version. mkdocs rewrites it to../../reports/model_accuracy_report.html.WinML CLI 0.1.0→0.2.0.docs/reports/model_accuracy_report.html).scripts/download_rules.py).--unsafetocheck-yamlso mkdocs-material's custom!!python/name:tags don't block commits that touchmkdocs.yml.Verification
mkdocs buildsucceeds;docs/reports/model_accuracy_report.htmlis published underreports/, whiledownload_report.pyandREADME.mdare excluded.../../reports/model_accuracy_report.html(resolves correctly within a version) with no broken-link warning.ruff check docs/reports/download_report.pypasses.Follow-ups
/reports/ongh-pagesis now superseded by the versioned copy and can be removed fromgh-pagesin a separate cleanup so there is a single canonical location.0.1.0→0.2.0edit is on the published HTML only; the report generator in the privategim-home/ModelKitArtifactsrepo should also emit the correct version so the nextdownload_report.pyrefresh doesn't reintroduce0.1.0.