Repository navigation
fix(docs): keep screenshots versioned docs still link - #7694
Conversation
The docs sync prunes every image in static/img/android/docs/ that no current page references. Frozen Docusaurus snapshots under versioned_docs/ link the same files, so a screenshot dropped from the app breaks the site build: meshtastic/meshtastic#2728 fails on three images the 2.7 snapshot still uses. Skip pruning any image a versioned_docs/ page links.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Priority: ➖ Normal Severity of issue fixed: Medium Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Regression Coverage For Changed Behavior |  |
Missing regression coverage for the changed docs-sync behavior. main() now calls collectVersionedImageReferences() before pruneStale(), and collectImageReferences() now removes query strings a… |
Add an integration test that runs scripts/sync-android-docs.js in a temporary fixture. Put stale images in static/img/android/docs/, reference one from nested versioned_docs/*.md and another from nested versioned_docs/*.mdx, includi… |
-
Check name Status Explanation Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title accurately describes the main change: preserving screenshots that versioned documentation still links. It is concise and specific, although the wording is slightly awkward. Linked Issues check Issue #7695requiressync-android-docs.jsto retain images linked byversioned_docs/. The change recursively reads.mdand.mdxfiles underversioned_docs, collects/img/android/docs/refe…Out of Scope Changes check The changes are limited to the sync script. The added versioned-document scan, URL normalization, retention logic, logging, and comments directly support issue #7695. No unrelated product or applicati…Sibling Call Sites And Presence Semantics PASS: The pull request changes only scripts/sync-android-docs.js. It adds versioned-document image retention and strips query strings/fragments from image paths. It does not change nullable fields, …Tests Prove The Path, Not The End State No tests were added or changed in the pull request. The only changed file is scripts/sync-android-docs.js, so the custom test-quality failure conditions do not apply. Moved Code Diffed Against Its Original The check is not applicable. The PR changes one existing JavaScript file in place; it does not delete and recreate a function or type, extract code into another module, or move a declaration. The diff… Full details: Linked Issues check
-
Explanation
Issue
#7695requiressync-android-docs.jsto retain images linked byversioned_docs/. The change recursively reads.mdand.mdxfiles underversioned_docs, collects/img/android/docs/references, strips query strings and fragments, and passes the protected names topruneStale. Current-page image handling remains separate. The implementation also logs each retained image.
Full details: Out of Scope Changes check
-
Explanation
The changes are limited to the sync script. The added versioned-document scan, URL normalization, retention logic, logging, and comments directly support issue
#7695. No unrelated product or application behavior changes are present.
Full details: Sibling Call Sites And Presence Semantics
-
Explanation
PASS: The pull request changes only
scripts/sync-android-docs.js. It adds versioned-document image retention and strips query strings/fragments from image paths. It does not change nullable fields, zero guards, presence checks, or numeric field defaults. NoNodeItem,NodeItemCompact, RSSI, temperature, current, voltage, particulate, humidity, or SNR call-site update is required.
Full details: Moved Code Diffed Against Its Original
-
Explanation
The check is not applicable. The PR changes one existing JavaScript file in place; it does not delete and recreate a function or type, extract code into another module, or move a declaration. The diff adds
collectVersionedImageReferences, changescollectImageReferencesandpruneStalein their original locations, and updates the singlepruneStalecaller. No moved-code contract needs comparison.
-
Full details: Regression Coverage For Changed Behavior
-
Explanation
Missing regression coverage for the changed docs-sync behavior.
main()now callscollectVersionedImageReferences()beforepruneStale(), andcollectImageReferences()now removes query strings and fragments. The observable surface is the generatedstatic/img/android/docs/assets consumed by the Docusaurusversioned_docs/build; no Android runtime surface is involved. The diff changes onlyscripts/sync-android-docs.jsand adds no test or test invocation. A versioned image can still be deleted, or a linked image with a query or fragment can be missed, without a test detecting it.Resolution
Add an integration test that runs
scripts/sync-android-docs.jsin a temporary fixture. Put stale images instatic/img/android/docs/, reference one from nestedversioned_docs/*.mdand another from nestedversioned_docs/*.mdx, including query-string or fragment suffixes, and assert both remain. Add an unreferenced stale image and assert it is removed. The test must fail against the base script.
- Fix all pre-merge checks with AI
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Comment @coderabbitai help to get the list of available commands.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: meshtastic/Meshtastic-Android/.coderabbit.yaml
- Review profile: CHILL
- Plan: Advanced
- Run ID:
17432aba-283f-4673-9360-6275e83fa460
📒 Files selected for processing: 1
scripts/sync-android-docs.js
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
A link such as /img/android/docs/old.webp?v=2 was recorded as old.webp?v=2, so it never matched the file and the image was pruned anyway. Strip any ?query or #fragment before taking the basename.
2 participants
Fixes #7695
The docs sync deletes every screenshot in
static/img/android/docs/that no current page references, but the frozen Docusaurus snapshots underversioned_docs/link the same files. When the app drops a screenshot, the site build fails: meshtastic/meshtastic#2728 is red becausenodes_node_list.webp,settings_password_field.webpandfirmware_disclaimer.webpwere pruned while the 2.7 snapshot still uses them.🐛 Bug Fixes
sync-android-docs.jsscansversioned_docs/**/*.md(x)for/img/android/docs/links and skips pruning those images, logging each one it keeps. Current pages are unaffected: an image stays only as a file, never as a link.Testing Performed
The script has no automated tests. Both scripts were run against a fresh checkout of
meshtastic/meshtasticmasterwith--convert-webp, sourcing docs from this branch:versioned_docs/version-2.7links: the three in docs: sync latest Android app documentation meshtastic#2728 and alsoconnections_empty_state.webp./img/android/docs/image thatversioned_docs/links still existed afterwards.The docs-site build was not run.
The docs repo's sync workflow runs this script from the latest Android release, so this fix takes effect on the first sync after it ships in a release.
Summary by CodeRabbit