Skip to content

doc: fix embed script filename and stale workflow path in dev docs - #2

Closed
olitreadwell wants to merge 2 commits into
mainfrom
docs/fix-embed-script-filename
Closed

olitreadwell wants to merge 2 commits into
mainfrom
docs/fix-embed-script-filename

Conversation

@olitreadwell

@olitreadwell olitreadwell commented Aug 12, 2026 •

Copy link
Copy Markdown
Owner

Closes #

This PR fixes a wrong file path in the dev setup docs.

readme/dev.md told contributors to run yarn dev:rollup "after changes to the embed/index.ts file".

That file does not exist.

The real embed entry file is embed/index.tsx: confirmed by rollup.config.js (input: "embed/index.tsx") and by the file that is actually on disk at embed/index.tsx.

This corrects the extension so the docs match the code.

How to test

  1. Open readme/dev.md and check the "Build the embed script" section.
  2. Confirm it now says embed/index.tsx.
  3. Confirm embed/index.tsx exists in the repo and rollup.config.js uses that same path as its input.

  • I added a CHANGELOG entry: skipped, this is a one-line docs typo fix with no user-facing or behavioural change
  • I made a self-review of my own code
  • I wrote tests for the changes (if applicable): N/A, docs-only change
  • I wrote configurator and chart config migrations (if applicable): N/A

Automation notes (fork-internal contribution run)

  • Repo: olitreadwell/visualization-tool (fork of visualize-admin/visualization-tool)

  • Type: docs-grounded fix (path mismatch between docs and code)

  • Evidence it was genuinely wrong:

    • readme/dev.md:80 (before fix) referenced embed/index.ts
    • ls embed/ shows only index.tsx, iframe-resizer.d.ts, tsconfig.json : no index.ts
    • rollup.config.js line 16: input: "embed/index.tsx", the build pipeline itself only knows about the .tsx file
  • Diff: 1 file changed, 1 line changed (well under the 80-line cap)

  • Checks: docs-only change, no test/lint/typecheck/build impact; verified the referenced file path directly against the filesystem and rollup.config.js instead of relying on a test suite

  • AI review (ocr): not installed/run in this environment (non-blocking per policy); did a careful manual self-review instead: single-line, low-risk change

  • Promotion command (for Oli to run himself, if he chooses to send this upstream):

    gh pr create --repo visualize-admin/visualization-tool --base main \
      --head olitreadwell:docs/fix-embed-index-path \
      --title "doc: fix embed script filename in dev setup docs" \
      --body-file <(git show HEAD --format=%b -s)

No CLA bot, no DCO/sign-off requirement, no commit-signing requirement found in this repo's CONTRIBUTING/workflows: should be a clean promotion.


All commits in this PR

This PR bundles 2 related fixes (same repo, same trivial-fix theme: broken links / typos / stale references), per the story-PR consolidation policy:

  • doc: fix embed script filename in dev setup docs
  • doc: fix stale workflow path and remove nonexistent script reference

How to verify

git fetch https://github.com/olitreadwell/visualization-tool.git docs/fix-embed-script-filename
git checkout FETCH_HEAD
# then run the repo's test command (see "Checks run locally" / CI)

AI assistance

Drafted with AI assistance.

The gap was found and verified against the current code, the change was verified before opening, and this diff was reviewed line by line.


PROMOTION NOTE (remove this section before/when opening against upstream):

gh pr create --repo visualize-admin/visualization-tool --base main --head olitreadwell:docs/fix-embed-script-filename

Prerequisites: none outstanding (re-verify CLA/DCO/signing before promoting).

- readme/dev.md told contributors to edit embed/index.ts
- the real file is embed/index.tsx (see rollup.config.js input and the
  file on disk); index.ts does not exist in the repo
- corrected the extension so the docs match the actual embed entry file
- readme/testing-general.md: the example `act` command referenced
  performance-tests-pr.yml, but that workflow was renamed to .yaml
  in a prior commit (ci: yml->yaml); update the doc to match.
- readme/testing-performance.md: remove the `yarn k6:codegen`
  reference, since no such script exists in package.json and never
  has in this repo's history; running it would fail.
@olitreadwell olitreadwell changed the title doc: fix embed script filename in dev setup docs doc: fix embed script filename and stale workflow path in dev docs Aug 19, 2026
@olitreadwell

Copy link
Copy Markdown
Owner Author

Closing as duplicate: the same change was already submitted upstream in visualize-admin#2601 (CLOSED). See visualize-admin#2601

@olitreadwell

Copy link
Copy Markdown
Owner Author

Superseded by upstream visualize-admin#2601.

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.

1 participant