From 76a05302f0d6cb825eb4df29518a71101e383e59 Mon Sep 17 00:00:00 2001 From: Anton Gilgur Date: Sat, 2 May 2020 22:50:57 -0400 Subject: [PATCH] (docs): remove version/permalink refs in template READMEs - don't want to have multiple references to versions that need to be updated along with package.json changes - these are for the most part wrapped by TSDX, so would only need to know a version in an advanced use-case, where having to check the package.json is not unreasonable - we also try to keep up with latest, so if it's bleeding edge or not shouldn't be impactful for too long - e.g. will be upgrading to Rollup v2 soon enough, no one's even requested it, so no need to add changing version in a few places to maintenance burden - also easy to forget to update and then have outdated/incorrect docs - same jive with permalink to PR -- if it's not already outdated, it's likely to become outdated often - reference Parcel's aliasing docs instead of PR that adds it --- templates/react-with-storybook/README.md | 6 +++--- templates/react/README.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/templates/react-with-storybook/README.md b/templates/react-with-storybook/README.md index ea937f3e0..05e426280 100644 --- a/templates/react-with-storybook/README.md +++ b/templates/react-with-storybook/README.md @@ -42,7 +42,7 @@ npm i # or yarn to install dependencies npm start # or yarn start ``` -The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, [we use Parcel's aliasing](https://github.com/palmerhq/tsdx/pull/88/files). +The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases). To do a one-off build, use `npm run build` or `yarn build`. @@ -50,7 +50,7 @@ To run tests, use `npm test` or `yarn test`. ## Configuration -Code quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. +Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. ### Jest @@ -82,7 +82,7 @@ We do not set up `react-testing-library` for you yet, we welcome contributions a ### Rollup -TSDX uses [Rollup v1.x](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. +TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. ### TypeScript diff --git a/templates/react/README.md b/templates/react/README.md index f14277a8a..4731bc031 100644 --- a/templates/react/README.md +++ b/templates/react/README.md @@ -26,7 +26,7 @@ npm i # or yarn to install dependencies npm start # or yarn start ``` -The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, [we use Parcel's aliasing](https://github.com/palmerhq/tsdx/pull/88/files). +The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases). To do a one-off build, use `npm run build` or `yarn build`. @@ -34,7 +34,7 @@ To run tests, use `npm test` or `yarn test`. ## Configuration -Code quality is [set up for you](https://github.com/palmerhq/tsdx/pull/45/files) with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. +Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly. ### Jest @@ -66,7 +66,7 @@ We do not set up `react-testing-library` for you yet, we welcome contributions a ### Rollup -TSDX uses [Rollup v1.x](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. +TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details. ### TypeScript