Skip to content

docs: remove three unreferenced README images - #819

Merged
antonwolfy merged 1 commit into
intel:mainfrom
antonwolfy:docs/remove-orphan-readme-images
Nov 16, 2026
Merged

antonwolfy merged 1 commit into
intel:mainfrom
antonwolfy:docs/remove-orphan-readme-images

Conversation

@antonwolfy

Copy link
Copy Markdown
Contributor

Summary

Follow-up to the review of #627, where three images in dokimi/docs/assets/readme/ were noted as orphaned (review).
On main (d92be0c), git grep for annotated-skill, shortening-strategies and three-questions finds no reference in docs, README.md, mkdocs.yml or tests, yet the three PNGs are in the tree.

Changes

  • Delete dokimi/docs/assets/readme/annotated-skill.png, shortening-strategies.png and three-questions.png; together they were 527,148 bytes (127,061 + 273,522 + 126,565).
  • No changelog fragment: the change is outside dokimi/dokimi/, dokimi/data/ and [project].

Risk

None: nothing references the files, and the docs build and link tests pass.

Testing

On a Linux review host, at f61bf57 (on main d92be0c):

  • make ci-local: 31 passed, 2 failed, 14 skipped. The two failures are Install gitleaks (the download returned HTTP 504) and Scan commits, which needs that binary; no scan ran. The skipped steps are the matrix legs on other Pythons, jobs that only run on other events, and checks needing tools not on the host (micromamba, semgrep). The full suite had 21732 passed, 19 skipped; mkdocs build, mypy, ruff, bandit and pre-commit pass.
  • tests/test_docs_links.py and tests/test_docs_code_refs.py: 75 passed.
  • No mutants: the change is a deletion with no new test.
  • Not run: the gitleaks scan, and the Python 3.11, 3.12 and 3.14 legs.

Open questions

None.

Revert

A plain revert restores the three images. Nothing is stored.

Checklist

  • Tests added/updated and pytest passes (N/A: no tests changed; the full suite passes)
  • ruff, mypy, and schema checks pass
  • Docs updated (or N/A) — see the docs-drift checklist in CONTRIBUTING.md
  • Self-reviewed per "Before opening a PR" in AGENTS.md
  • Each new raise/exit and test names the doc, contract or issue it traces to
  • No ad-hoc run artifacts committed
  • New files carry the SPDX license header (or are exempt in .github/.licenserc.yaml)

Settles the review point on intel#627 (B2.1) that `annotated-skill.png`, `shortening-strategies.png` and `three-questions.png` in `dokimi/docs/assets/readme/` are orphaned.

`git grep` for each name and stem across the tree (docs, README, mkdocs.yml, tests) finds no reference, so the three files are deleted with no other change.

Signed-off-by: Anton Volkov <antonwolfy@gmail.com>
@antonwolfy
antonwolfy requested a review from a team as a code owner November 16, 2026 11:53
@antonwolfy antonwolfy self-assigned this Nov 16, 2026
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.77%. Comparing base (d92be0c) to head (f61bf57).
⚠️ Report is 2 commits behind head on main.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #819      +/-   ##
==========================================
+ Coverage   95.76%   95.77%   +0.01%     
==========================================
  Files         416      416              
  Lines       55624    55624              
  Branches     9553     9553              
==========================================
+ Hits        53267    53275       +8     
+ Misses       1456     1449       -7     
+ Partials      901      900       -1     

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@vchamarthi vchamarthi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approved · reviewed f61bf57

Next: nothing required from @antonwolfy.

Verified on f61bf57: ✅ full suite with main merged in: 22216 passed · ✅ merges onto main

6 checks behind it, each with its evidence
Area What holds How
Deleted images The diff changes only annotated-skill.png, shortening-strategies.png and three-questions.png under dokimi/docs/assets/readme/, and all three are gone on the head ran it
References No file on the head names annotated-skill, shortening-strategies or three-questions, so the deletion breaks no doc link, mkdocs build or test ran it
Size The three PNGs total 527,148 bytes on main (127,061 + 273,522 + 126,565), as the description says ran it
Changelog fragment The changed paths sit outside dokimi/dokimi/, dokimi/data/ and the [project] table, so no changelog fragment is required, as the description says ran it
Docs and tests make ci-local passes with main merged in: mkdocs build passes and 22216 tests pass with none failing full suite, main merged in
Merge The PR merges onto current main with no conflict merge onto main

@antonwolfy
antonwolfy merged commit ba74e4a into intel:main Nov 16, 2026
23 checks passed
@antonwolfy
antonwolfy deleted the docs/remove-orphan-readme-images branch November 16, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants