Skip to content

Docs: correct three claims that no longer match the code - #11

Merged
SandObserver merged 1 commit into
mainfrom
docs/correct-stale-claims
Aug 9, 2026
Merged

SandObserver merged 1 commit into
mainfrom
docs/correct-stale-claims

Conversation

@SandObserver

Copy link
Copy Markdown
Owner

Summary

  • docs/frontend.md: replace the claim that the widget ?v= is manual. The release hashes each widget's entry files into entryVersions in its widget.json, and ui/js/widget-types.js:59 reads the hash from there when it builds the iframe URL.
  • Add two tests to ui/test/cache-busting.test.mjs: one asserting widget-types.js still reads the manifest hash and that no literal ?v= stamp appears in a widget URL, one asserting the guide's Cache busting section names entryVersions and no longer says the value is manual.
  • CONTRIBUTING.md: the unit runner needs nothing installed, but coverage (c8) and the browser tests (Playwright) use the root dev tooling.
  • playwright.config.js: the header claimed coverage of drag reordering, focus handling and Persian mirroring. The five specs cover listing seeded apps, adding, editing, reload persistence and widget type; the header now says so and names the gaps.

Testing
All green. Added 2 tests; mutation-checked by restoring the "is manual" wording and by planting a literal widget stamp, each of which fails.

Checklist

  • Stays within the project constraints: one container, no runtime dependencies, no build step (see CONTRIBUTING.md).
  • Tests added or updated for new logic, and the full suite, lint, and typechecks pass.
  • Docs updated if behavior or configuration changed.
  • CHANGELOG.md updated under Unreleased if the change is user-visible.

The frontend guide told contributors the widget `?v=` was manual and to bump it
when a widget's files changed. It has not been manual since entryVersions: the
release hashes each entry file into the manifest and widget-types.js reads it
from there, so following the guide meant hand-editing a value the build owns.
Two tests pin the mechanism.

The contributor guide claimed no test dependencies while c8 and Playwright are
installed. The Playwright config claimed tests for drag reordering, focus and
Persian mirroring; the five specs cover listing, adding, editing, reload
persistence and widget type.
@SandObserver SandObserver added the documentation Improvements or additions to documentation label Aug 9, 2026
@SandObserver
SandObserver merged commit 3b98893 into main Aug 9, 2026
4 checks passed
@SandObserver
SandObserver deleted the docs/correct-stale-claims branch August 9, 2026 22:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant