Skip to content

Commit de836b3

Browse files
Update README.md
1 parent 43b6a5e commit de836b3

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
- [Number Labelling](#number-labelling)
2424
- [Component-extension Pointers](#component-extension-pointers)
2525
- [Section Comment](#section-comment)
26+
- [Documentation and styleguide](#documentation-and-styleguide)
2627
- [Naming Conventions](#naming-conventions)
2728
- [BEM-like Naming](#bem-like-naming)
2829
- [Hyphen-delimited](#hyphen-delimited)
@@ -929,8 +930,19 @@ This type of comment is rare due to us working in highly concentrated partials
929930
========================================================================= */
930931
```
931932

933+
## Documentation and styleguide
932934

935+
As a way to improve the consistency and comunication across the designer and front-end team, we are following the Styleguide driven development methodology. One of the devs created a very usefull presentation when we first started this and you can find it [here](https://docs.google.com/a/personalcapital.com/presentation/d/17Q0HNynYGbbTPqbhp7yDZ1Ki9kvrf7JvJfZqnDV5npY/edit?usp=sharing)
933936

937+
As you can see we are using *kss* which is a special format to write CSS documentation, which with the right tool can be parsed and converted in to a beautifull styleguide. To read more about KSS format click [here](https://github.com/kneath/kss/blob/master/SPEC.md).
938+
939+
By now, we have a few NPM scripts that you can run to generate and serve the styleguide.
940+
*`npm run build-styleguide` will generate the static files of the styleguide on `styleguide/dist` folder.
941+
*`npm run serve-styleguide` will build the styleguide static files and serve them using `node-serve` on 127.0.0.1:8080. If you use localhost instead, this might not work since some browsers redirect to `https`
942+
943+
*Every new reusable component should have the related KSS documentation so other devs can see and reuse the implementation.*
944+
945+
One last thing, the CI build processes for the web app build the styleguide too, so every environment should have the styleguide under `<domain>/static/styleguide/dist/index.html`. Even production.
934946

935947
## Naming Conventions
936948

0 commit comments

Comments
 (0)