From 5476904bf53c715c9bd4ff9bec09a1fc4f01a4e1 Mon Sep 17 00:00:00 2001 From: Jennifer Shehane Date: Tue, 7 Sep 2021 08:21:53 -0500 Subject: [PATCH] docs: Add readmes to packages that are missing Readmes (#17937) Co-authored-by: Ben Kucera <14625260+Bkucera@users.noreply.github.com> Co-authored-by: Tim Griesser --- packages/resolve-dist/README.md | 3 +++ packages/ts/README.md | 9 +++++++++ packages/web-config/README.md | 14 ++++++++++++++ 3 files changed, 26 insertions(+) create mode 100644 packages/resolve-dist/README.md create mode 100644 packages/ts/README.md create mode 100644 packages/web-config/README.md diff --git a/packages/resolve-dist/README.md b/packages/resolve-dist/README.md new file mode 100644 index 0000000000..37ee94393d --- /dev/null +++ b/packages/resolve-dist/README.md @@ -0,0 +1,3 @@ +# Resolve Dist + +This package centralizes the resolution of paths to compiled/static assets from server-side code. diff --git a/packages/ts/README.md b/packages/ts/README.md new file mode 100644 index 0000000000..dcf27567d4 --- /dev/null +++ b/packages/ts/README.md @@ -0,0 +1,9 @@ +# TS + +Internal package used to standardize this repo's version of `ts-node` used for development. In production we pre-transpile all of the typescript so this packages `register` export is a no-op + +## Installing +N/A - handled by the top level `yarn install` + +## Developing & Testing +N/A diff --git a/packages/web-config/README.md b/packages/web-config/README.md new file mode 100644 index 0000000000..8dbe591691 --- /dev/null +++ b/packages/web-config/README.md @@ -0,0 +1,14 @@ +# Web Config + +Internal package to standardize this repo's web-related configuration + +**includes:** +- a base webpack config that we share and build upon between many projects +- utilities for setting up nodejs unit testing in a mocked web environment. +- anything else that keeps web-related configuration common to multiple packages in-sync and DRY. + +## Installing +N/A - handled by the top level `yarn install` + +## Developing & Testing +N/A