doc: fix embed script filename in dev setup docs - #2601
Open
olitreadwell wants to merge 2 commits into
Open
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
Contributor
|
@olitreadwell is attempting to deploy a commit to the visualize-admin-ch Team on Vercel. A member of the Team first needs to authorize it. |
- 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.
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.
Closes # Not Applicable
This PR fixes a wrong file path in the dev setup docs.
readme/dev.mdtold contributors to runyarn dev:rollup"after changes tothe
embed/index.tsfile". That file does not exist. The real embed entryfile 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.jsusesthat same path as its
input.with no user-facing or behavioural change