doc: fix embed script filename and stale workflow path in dev docs - #2
Closed
olitreadwell wants to merge 2 commits into
Closed
olitreadwell wants to merge 2 commits into
olitreadwell wants to merge 2 commits into
Conversation
- 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.
Owner
Author
|
Closing as duplicate: the same change was already submitted upstream in visualize-admin#2601 (CLOSED). See visualize-admin#2601 |
Owner
Author
|
Superseded by upstream visualize-admin#2601. |
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
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.
Closes #
This PR fixes a wrong file path in the dev setup docs.
readme/dev.mdtold contributors to runyarn dev:rollup"after changes to theembed/index.tsfile".That file does not exist.
The real embed entry file is
embed/index.tsx: confirmed byrollup.config.js(input: "embed/index.tsx") and by the file that is actually on disk atembed/index.tsx.This corrects the extension so the docs match the code.
How to test
readme/dev.mdand check the "Build the embed script" section.embed/index.tsx.embed/index.tsxexists in the repo androllup.config.jsuses that same path as itsinput.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) referencedembed/index.tsls embed/shows onlyindex.tsx,iframe-resizer.d.ts,tsconfig.json: noindex.tsrollup.config.jsline 16:input: "embed/index.tsx", the build pipeline itself only knows about the.tsxfileDiff: 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.jsinstead of relying on a test suiteAI 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):
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:
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):
Prerequisites: none outstanding (re-verify CLA/DCO/signing before promoting).