Skip to content

Match docs to the window, trim check loops - #164

Merged
wallstop merged 5 commits into
mainfrom
t153-docs-copy-fast-checks
Oct 10, 2026
Merged

wallstop merged 5 commits into
mainfrom
t153-docs-copy-fast-checks

Conversation

@wallstop

@wallstop wallstop commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

DISCLOSURE: LLM-GENERATED TEXT

Why: The docs contradicted the window in three behavior claims, and every PR paid the harness self-test suite even when it could not fail.

What:

  • Fix processor, pane-width, and persistence docs against the code
  • Rename stale prose and menu paths to DxVisualizer
  • Skip harness self-tests when their verified surface is unchanged
  • Add npm run check:fast for changed-file local validation

Fixes #153. Refs #149, #146.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactor (code change that neither fixes a bug nor adds a feature)

Checklist

  • I have added tests that prove my fix is effective or my feature works
  • I have updated the documentation accordingly
  • I have updated the CHANGELOG for user-facing changes
  • My changes do not introduce breaking changes, or breaking changes are documented

Note

Low Risk
Changes are mostly documentation and CI/dev harness scripts; the only runtime edit is a settings tooltip string with no behavior change.

Overview
Aligns user-facing docs and settings copy with actual window behavior, and speeds up local and CI validation when harness tooling is untouched.

Docs and UI copy: README and docs/ are updated for the DxVisualizer menu/branding while noting code identifiers stay DataVisualizer. Processor docs now state that missing Accepts means the processor is never offered (matching DataVisualizer.cs). Persistence text uses Persist State in Settings Asset and correct on/off semantics; pane widths are documented as always stored in editor preferences. The settings asset tooltip is corrected in DataVisualizerSettings.cs.

Faster checks: Adds npm run check:fast (scripts/fast-check.ps1) to format/lint only changed paths since origin/main (or merge-base), skip harness self-tests when the harness surface is unchanged, and avoid passing deleted or rename-old paths into formatters. CI gains the same skip via harness-scope.psm1, should-run-self-tests.ps1, and a conditional step in llm-lint.yml. Harness scope and fast-check planning are covered by new self-tests; agent guidance and a forbidden-pattern row document the deletion/rename filtering rule.

Reviewed by Cursor Bugbot for commit e6fbad7. Bugbot is set up for automated code reviews on this repo. Configure here.

The rebrand left the docs behind the renamed window, and three claims
contradicted the code (INCONSISTENCIES I-01..I-03). A processor whose
Accepts list is null is skipped during discovery, so it is never
offered, not offered for every type. Splitter widths persist through
EditorPrefs keys, never with the settings asset, so the pane-width
clause drops out of the shared-state sentence. The persistence toggle
reads Persist State in Settings Asset on screen, so the docs now name
that label and describe the default as off. The settings tooltip had
the two save locations swapped; it now matches the field. The row
actions are the four buttons on each row, not controls above the
object list, and menu paths read Tools > Wallstop Studios >
DxVisualizer per the 147 rename.

Fixes #153. Progresses #149 and #146.
The llm-lint workflow's slowest step is the self-test suite (71s of the
97s Windows job), and it ran on every triggered push or PR even when
only docs or C# changed, which cannot affect any self-test outcome. A
shared scope module now decides from the changed paths; the workflow
resolves the base sha, fetches it shallowly when checkout did not
include it, and runs the suite only when the harness surface (scripts,
.llm, .github, .devcontainer, .config, manifests) moved. The verdict
fails safe: an unresolvable base always runs the suite. Coverage is
unchanged - every surface change still runs the full suite on both
operating systems.
The validation ladder reruns whole-tree formatting, every harness lint,
the full self-test suite, and npm pack for any edit, so a one-line fix
costs around a minute per iteration. npm run check:fast now classifies
the paths changed since origin/main and runs only the groups that can
fail: CSharpier plus the C# source lints for .cs, prettier plus the
changelog cap for .md, the harness lints and self-tests for the harness
surface, npm pack for the package payload, and the assembly, release,
and line-ending guards for their own files. It reuses the scope module
the CI skip logic uses, so both verdicts stay identical. The full
ladder still gates review.
The rebrand renamed the product and menu paths, and the extending page
was missing the handoff note that namespaces, types, and assemblies are
unchanged, so readers could not tell whether their code needed edits.

Refs #149.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ae16683. Configure here.

Comment thread scripts/fast-check.ps1 Outdated
Bugbot on PR 164 found that the plan fed every changed .cs and .md
path to csharpier and prettier, including deletions and the old path
of a rename, so the first delete or rename on a branch broke
check:fast for every later iteration. Group triggers still see the
full changed list - deleting a harness file must keep running the
self-tests, and deleting the changelog must fail closed per its
contract - but the formatter lists now keep only paths that exist on
disk. Three fixture cases pin the shape: working-tree deletions,
committed deletions, and the rename old-path. The pattern joins the
forbidden list with the other guards-that-lie rows.
@wallstop
wallstop merged commit 253a720 into main Oct 10, 2026
5 checks passed
@wallstop
wallstop deleted the t153-docs-copy-fast-checks branch October 10, 2026 15:32
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.

Resolve documentation inconsistencies against the code

1 participant