From ee3e25f7799593c6a6c6643c04faa9ca0750d450 Mon Sep 17 00:00:00 2001 From: jedmao Date: Wed, 22 May 2019 17:13:50 -0500 Subject: [PATCH 1/2] Add TOC, Scaffolding to tech vision doc --- design-documents/frontend/technical-vision.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/design-documents/frontend/technical-vision.md b/design-documents/frontend/technical-vision.md index 5f61c3a8e..e968e9bd8 100644 --- a/design-documents/frontend/technical-vision.md +++ b/design-documents/frontend/technical-vision.md @@ -12,6 +12,19 @@ The following document is a guide for all _future_ Magento front-end application - Productivity (Efficiency) - Quality (Reliability) +## Table of Contents + +- [React](#react) +- [TypeScript](#typescript) +- [Portability](#portability) +- [Browser Support](#browser-support) +- [React UI Component Library](#react-ui-component-library) +- [Styles](#styles) +- [Accessibility](#accessibility) +- [Code Quality](#code-quality) +- [Testing](#testing) +- [Scaffolding](#scaffolding) + ## [React][] _Portability, Performance, Productivity, Quality, Internationalization._ @@ -181,9 +194,14 @@ _Disclaimer: the above list is not exhaustive and is in no particular order._ Ideally, for each front-end project, there will be a separate project that covers both performance and critical-path testing. This project is separate so that it doesn't cripple the short feedback loops of feature development. Additionally, we would do well to have additional performance testing around the most commonly used components (e.g., used in 3+ places). +## Scaffolding + +[Yeoman][] is the de facto standard for scaffolding modern web applications. In an effort to make the above guide as painless as possible and to encourage best practices, a [TSX Yeoman Generator](https://www.npmjs.com/package/generator-tsx) has been created for you. Refer to its documentation for more information. + [CRA]: https://facebook.github.io/create-react-app/ [Jest]: https://jestjs.io/ [Prettier]: https://prettier.io/ [React]: https://reactjs.org/ [TSLint]: https://palantir.github.io/tslint/ [Typescript]: http://www.typescriptlang.org/ +[Yeoman]: https://yeoman.io/ From 2d7d742d81a8e83b62adf3b69b3937e890a2b26f Mon Sep 17 00:00:00 2001 From: jedmao Date: Thu, 23 May 2019 11:14:01 -0500 Subject: [PATCH 2/2] Address CR feedback --- design-documents/frontend/technical-vision.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/design-documents/frontend/technical-vision.md b/design-documents/frontend/technical-vision.md index e968e9bd8..fe911cacc 100644 --- a/design-documents/frontend/technical-vision.md +++ b/design-documents/frontend/technical-vision.md @@ -196,7 +196,7 @@ Ideally, for each front-end project, there will be a separate project that cover ## Scaffolding -[Yeoman][] is the de facto standard for scaffolding modern web applications. In an effort to make the above guide as painless as possible and to encourage best practices, a [TSX Yeoman Generator](https://www.npmjs.com/package/generator-tsx) has been created for you. Refer to its documentation for more information. +[Yeoman][] is a tool for scaffolding modern web applications. In an effort to make the above guide as painless as possible and to encourage best practices, a [TSX Yeoman Generator](https://www.npmjs.com/package/generator-tsx) has been created for you. Refer to its documentation for more information. [CRA]: https://facebook.github.io/create-react-app/ [Jest]: https://jestjs.io/