diff --git a/DEV_DOCS.md b/DEV_DOCS.md index ead70eeeb..591e2d444 100644 --- a/DEV_DOCS.md +++ b/DEV_DOCS.md @@ -30,7 +30,7 @@ Docs is a separate Angular application located right in this project in [docs](./docs) folder. The pages structure is taken from `structure.ts` file. -The components documentation is take from the component comment sections. +The components documentation is taken from the component comment sections. # Framework Structure @@ -59,7 +59,7 @@ Located in [./src/framework/theme](./src/framework/theme) Located in [./src/framework/ui](./src/framework/ui) -Each component implementation can be found in directory with corresponding name. +Each component implementation can be found in a directory with the corresponding name. #### UI component directory structure: @@ -67,7 +67,7 @@ Each component implementation can be found in directory with corresponding name. - `*.spec.tsx` - component tests. - `*.spec.tsx.snap` - component test snapshots. This is a generated file. Could be presented or not depending on tests. -Some of components can have more complex implementation. In this case the final component implementation could be divided into sub-components, but tests should be written in a single `*.spec` file. The good example is [TabView](./src/framework/ui/tab). +Some of the components can have a more complex implementation. In this case, the final component implementation could be divided into sub-components, but tests should be written in a single `*.spec` file. The good example is [TabView](./src/framework/ui/tab). # Documentation @@ -75,12 +75,12 @@ Some of components can have more complex implementation. In this case the final Documentation is generated by the custom generator built on top of UI Kit. You have to use typedoc everywhere for the documentation purpose. -## How to add page to the documentation +## How to add a page to the documentation -Docs application splitted on the sections which you can find in the apps sidebar. +Docs application split into the sections which you can find in the app's sidebar. Each section contains some pages. If you wanna add new page in the documentation, please, open `structure.ts` -file in the root of docs application and add new page in the required section: +file in the root of docs application and add a new page in the required section: ``` { @@ -92,7 +92,7 @@ file in the root of docs application and add new page in the required section: }, ``` -If it's completely new feature, maybe it would be better to create a new section: +If it's a completely new feature, maybe it would be better to create a new section: ``` { @@ -128,7 +128,7 @@ For example, if you wanna add getting started article you have to do the followi ### Component block -If you have to render all the information about componend parsed with typedoc +If you have to render all the information about component parsed with typedoc you have to use component blocks: ``` @@ -169,7 +169,7 @@ You have the following ways to add examples in your component documentation: ### Add raw code -If you wan't to describe small thing in two lines of code you can just add something similar in your typedoc comment: +If you wan't to describe a small thing in two lines of code you can just add something similar in your typedoc comment: ```` ```jsx @@ -179,7 +179,7 @@ const AwesomeComponentShowcase = () => ( ``` ```` -And don't forget specify language above your example. +And don't forget to specify the language above your example. ## Development @@ -226,7 +226,7 @@ To start a new release (publish the framework packages on NPM) you need: 6. Fix/expand changelog manually 7. Update documentation (e.g [DEV_DOCS.md](./DEV_DOCS.md)) files if needed 8. Push the branch, create PR, approve - merge -9. Pull the upstream (master or other version branch (e.g. 4.0.1, next)) +9. Pull the upstream (master or another version branch (e.g. 4.0.1, next)) 10. Run tests: `npm run release:validate` 11. Assemble build: `npm run release:prepare` 12. Publish the package to npm: `npm run release`