Skip to content

Commit e4ec0cf

Browse files
authored
Add TOC, Scaffolding to tech vision doc (#166)
1 parent 88032ac commit e4ec0cf

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

design-documents/frontend/technical-vision.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ The following document is a guide for all _future_ Magento front-end application
1212
- Productivity (Efficiency)
1313
- Quality (Reliability)
1414

15+
## Table of Contents
16+
17+
- [React](#react)
18+
- [TypeScript](#typescript)
19+
- [Portability](#portability)
20+
- [Browser Support](#browser-support)
21+
- [React UI Component Library](#react-ui-component-library)
22+
- [Styles](#styles)
23+
- [Accessibility](#accessibility)
24+
- [Code Quality](#code-quality)
25+
- [Testing](#testing)
26+
- [Scaffolding](#scaffolding)
27+
1528
## [React][]
1629

1730
_Portability, Performance, Productivity, Quality, Internationalization._
@@ -181,9 +194,14 @@ _Disclaimer: the above list is not exhaustive and is in no particular order._
181194

182195
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).
183196

197+
## Scaffolding
198+
199+
[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.
200+
184201
[CRA]: https://facebook.github.io/create-react-app/
185202
[Jest]: https://jestjs.io/
186203
[Prettier]: https://prettier.io/
187204
[React]: https://reactjs.org/
188205
[TSLint]: https://palantir.github.io/tslint/
189206
[Typescript]: http://www.typescriptlang.org/
207+
[Yeoman]: https://yeoman.io/

0 commit comments

Comments
 (0)