Repository navigation
docs(help): CI guard + image checks, remove stale HTML, de-dup, drop junk folder - #170
Merged
Merged
Conversation
…junk folder Maintenance batch (stacked on the desktop-UI prune): #1 CI: add .github/workflows/check-help-docs.yml running check-help-docs.ps1 on PRs/pushes touching Help/ (windows-latest); fails on broken .md links, broken image links, or table/index drift. VisualText#5 Guard script: add broken-image-link checking to the gating path and a -Images mode that lists orphaned image assets (referenced by no page). #2 Remove the stale CHM/HTML build tree under Help/helps/ (561 .htm plus .html/.css/.hhc/.hhk/.js/.xml/.glo/.brs). KEPT all 480 image assets, which the markdown references via ../helps/. #3 De-duplicate debug/fail: the flat pages and the Functions/ copies had diverged. Merged the PRE-action accuracy into flat debug.md, added the CHECK Actions link to fail.md, repointed all references (index, exitpass, or, succeed) to the flat copies, and removed the Functions/ folder. #4 Remove the Possibly_JUNK/ folder: NLP++.md was explicitly marked "slated for removal" and is superseded by the NLP++ section; Basic_steps... is a legacy desktop-GUI walkthrough. Removed both and their index entries. Verified: check-help-docs.ps1 reports 0 broken links, 0 broken images, 0 table/index drift. Note: -Images surfaces 131 orphaned image assets (mostly desktop-UI screenshots orphaned by the page prune) -- left for a follow-up. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Summary
Documentation-maintenance batch — the five follow-up suggestions, done together.
1. CI guard (
.github/workflows/check-help-docs.yml)Runs
Help/check-help-docs.ps1on every PR/push touchingHelp/(onwindows-latest, matching the script's path logic). Fails the build on broken.mdlinks, broken image links, or table/index drift — so none of the prior cleanup can silently regress.5. Guard script: image checking
Added broken-image-link detection to the gating path, plus a
-Imagesmode that lists orphaned image assets (on disk, referenced by no page). (-Stubsfrom before still lists empty doc sections.)2. Removed the stale CHM/HTML build tree under
Help/helps/Deleted the 561
.htmplus the.html/.css/.hhc/.hhk/.js/.xml/.glo/.brsCHM artifacts. Kept all 480 image assets — the markdown references them via../helps/…, so the folder is the live image store, not just dead HTML.3. De-duplicated
debug/failEach existed twice (flat + under
Functions/) and had diverged. Merged the PRE-action accuracy into the flatdebug.md, added the CHECK-Actions link tofail.md, repointed every reference (index,exitpass,or,succeed) to the flat copies, and removed theFunctions/folder.4. Removed
Possibly_JUNK/NLP++.mdwas explicitly marked "slated for removal" (and is superseded by the NLP++ section);Basic_steps…is a legacy desktop-GUI walkthrough. Removed both and their index entries.Validation
check-help-docs.ps1: 0 broken links, 0 broken images, 0 table/index drift.Follow-up the new tooling surfaced
-Imagesreports 131 orphaned image assets — almost entirely desktop-UI screenshots (helps/VisualText_Interface/Popups,Menus,Toolbars,Tools,Toolbar_buttons…) orphaned when the desktop-UI pages were removed. Left out of this PR as a separate decision; happy to purge them next.🤖 Generated with Claude Code