Easy Bolt-on Docs Using React Styleguidist

James Stone
James StoneSenior Software Developer at Futurice
Easy Bolt-on Docs Using React Styleguidist
How to document systems built in
react in a reactish way
WHY WHY NOT WHY NOT X
HOW WHERE
THE WHO THE WHAT
Why trust me?
One way to go pro
Why Finland?
Science.
ZURB Foundation
Top Contributor, Certified Preferred, etc.
A*%#@& => React
5 STAGES OF GRIEF
1. Denial
2. Anger
3. Bargaining
4. Depression
5. Acceptance
5 STAGES OF GRIEF
source: wikipedia
5 STAGES OF GRIEF WITH ANGULAR
1. Denial I'm just doing this until Vue.js catches on
2. Anger Nested ternaries, button components, CSS in JS
3. Bargaining wix/react-templates
4. Depression Endless videos and tutorials
5. Acceptance I'm now okay, but Functional Programing...
WHY A LIVING STYLEGUIDE
1. Foster better communication
2. Play to your team's strengths
3. Avoid conflict between teams
4. Produce a better quality product
5. More design consistency
6. Less meetings
source: Design Systems Crash Course
In my experience there are two ways to get started with creating a
Design System that will work for an organization of any size. Even a
web team of one.
‣ Front-end Code
‣ Living Styleguide
source: Design Systems Crash Course
Both of these are what I like to call low hanging fruit. This means that
you will be able to build these the fastest, with the least amount of
effort and they will have the biggest rewards.
source: Design Systems Crash Course
WHY NOT X STORYBOOK
‣ You write stories in JavaScript files (vs md)
‣ How you describe components
‣ Shows only one variation at a time (vs. multiple)
source: React Styleguidist Cookbook
REACT STLYEGUIDIST GIVES YOU
‣ Auto public method docs
‣ All components on a single page (Styleguide)
‣ Extra docs added (Design System or More complete docs)
‣ Can be branded (customizable design)
‣ You get some docs auto generated*
STORYBOOK EXAMPLE
import React from "react";
import { storiesOf } from "@storybook/react";
import { action } from "@storybook/addon-actions";
import Button from "../components/Button";
storiesOf("Button", module).add("default", () => (
<Button onClick={action("clicked")}>Push Me</Button>
));
REACT STYLEGUIDIST EXAMPLE
```js
<Button onClick={() => console.log('clicked')>Push Me</Button>
```
REACT STYLEGUIDIST EXAMPLE (FENCES REMOVED)
<Button onClick={() => console.log('clicked')>Push Me</Button>
HOW REDUX TODO MVC EXAMPLE
WHERE
github.com/jamesstoneco/react-styleguidist-todo
Easy Bolt-on Docs Using React Styleguidist
1 of 23

Recommended

Continuous Testing With React Storybook & WebdriverIO by
Continuous Testing With React Storybook & WebdriverIOContinuous Testing With React Storybook & WebdriverIO
Continuous Testing With React Storybook & WebdriverIOJosh Cypher
701 views55 slides
Continuous Deployment by
Continuous DeploymentContinuous Deployment
Continuous DeploymentCodeship
468 views51 slides
Watson open scale tutorial by
Watson open scale tutorialWatson open scale tutorial
Watson open scale tutorialJane Fung
20 views12 slides
Getting Started With Apex as an Admin by Christopher Lewis by
Getting Started With Apex as an Admin by Christopher LewisGetting Started With Apex as an Admin by Christopher Lewis
Getting Started With Apex as an Admin by Christopher LewisSalesforce Admins
119 views21 slides
Df16 getting started with apex as an admin by
Df16  getting started with apex as an adminDf16  getting started with apex as an admin
Df16 getting started with apex as an adminChristopher Lewis
127 views21 slides
How To Upload A Power Point Presenatation by
How To Upload A Power Point PresenatationHow To Upload A Power Point Presenatation
How To Upload A Power Point Presenatationguest797e8c9
130 views2 slides

More Related Content

What's hot

Agile Engineering Practices by
Agile Engineering PracticesAgile Engineering Practices
Agile Engineering PracticesKane Mar
1.5K views79 slides
What Visual Studio Code can do for Java Development by
What Visual Studio Code can do for Java DevelopmentWhat Visual Studio Code can do for Java Development
What Visual Studio Code can do for Java DevelopmentEd Burns
171 views14 slides
Video Marketing Made Easy by
Video Marketing Made EasyVideo Marketing Made Easy
Video Marketing Made EasyMichele Mere
426 views25 slides
Diy continuous integration by
Diy continuous integrationDiy continuous integration
Diy continuous integrationPromet Source
1.7K views24 slides
Delhi first draft by
Delhi first draftDelhi first draft
Delhi first draftvaibhav lokhande
44 views18 slides
Better than google. by
Better than google.Better than google.
Better than google.Joao286698
14 views2 slides

What's hot(19)

Agile Engineering Practices by Kane Mar
Agile Engineering PracticesAgile Engineering Practices
Agile Engineering Practices
Kane Mar1.5K views
What Visual Studio Code can do for Java Development by Ed Burns
What Visual Studio Code can do for Java DevelopmentWhat Visual Studio Code can do for Java Development
What Visual Studio Code can do for Java Development
Ed Burns171 views
Video Marketing Made Easy by Michele Mere
Video Marketing Made EasyVideo Marketing Made Easy
Video Marketing Made Easy
Michele Mere426 views
Diy continuous integration by Promet Source
Diy continuous integrationDiy continuous integration
Diy continuous integration
Promet Source1.7K views
Better than google. by Joao286698
Better than google.Better than google.
Better than google.
Joao28669814 views
Essential Technical SEO learnings from 120+ site migrations by Chris Green
Essential Technical SEO learnings from 120+ site migrationsEssential Technical SEO learnings from 120+ site migrations
Essential Technical SEO learnings from 120+ site migrations
Chris Green154 views
ใบงานสำรวจตนเอง by Panaphat Panpan
ใบงานสำรวจตนเองใบงานสำรวจตนเอง
ใบงานสำรวจตนเอง
Panaphat Panpan95 views
4 Simple Steps to Becoming a Blueworks Live Process Ninja by Robert (Bob) Spory
4 Simple Steps to Becoming a Blueworks Live Process Ninja4 Simple Steps to Becoming a Blueworks Live Process Ninja
4 Simple Steps to Becoming a Blueworks Live Process Ninja
Robert (Bob) Spory785 views
Steps For Uploading Presentations by guest5d54198
Steps For Uploading PresentationsSteps For Uploading Presentations
Steps For Uploading Presentations
guest5d54198118 views
Moving Large Apps to React - NYC JS by stan229
Moving Large Apps to React - NYC JSMoving Large Apps to React - NYC JS
Moving Large Apps to React - NYC JS
stan2291.4K views
Sql server 2008 r2 installation instructions by Copen Hagen
Sql server 2008 r2 installation instructionsSql server 2008 r2 installation instructions
Sql server 2008 r2 installation instructions
Copen Hagen990 views
How to - Add RSS feeds to Netvibes by mmoore17
How to - Add RSS feeds to NetvibesHow to - Add RSS feeds to Netvibes
How to - Add RSS feeds to Netvibes
mmoore175.3K views
Part 6 – adding dots and scores by Andrew Willetts
Part 6 – adding dots and scoresPart 6 – adding dots and scores
Part 6 – adding dots and scores
Andrew Willetts1.6K views
Tutorial how to create a simple maven project by ssuser29f27f
Tutorial how to create a simple maven projectTutorial how to create a simple maven project
Tutorial how to create a simple maven project
ssuser29f27f47 views
QCon Beijing - April 2010 by Kane Mar
QCon Beijing - April 2010QCon Beijing - April 2010
QCon Beijing - April 2010
Kane Mar1.3K views

Similar to Easy Bolt-on Docs Using React Styleguidist

Automated testing with Cypress by
Automated testing with CypressAutomated testing with Cypress
Automated testing with CypressYong Shean Chong
639 views44 slides
Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose preso by
Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose presoTest Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose preso
Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose presoElad Elrom
2.7K views52 slides
Test Driven Development (TDD) Preso 360|Flex 2010 by
Test Driven Development (TDD) Preso 360|Flex 2010Test Driven Development (TDD) Preso 360|Flex 2010
Test Driven Development (TDD) Preso 360|Flex 2010guest5639fa9
536 views52 slides
Turku loves-storybook-styleguidist-styled-components by
Turku loves-storybook-styleguidist-styled-componentsTurku loves-storybook-styleguidist-styled-components
Turku loves-storybook-styleguidist-styled-componentsJames Stone
489 views29 slides
Untangling7 by
Untangling7Untangling7
Untangling7Derek Jacoby
343 views27 slides
Front-End Modernization for Mortals by
Front-End Modernization for MortalsFront-End Modernization for Mortals
Front-End Modernization for Mortalscgack
400 views80 slides

Similar to Easy Bolt-on Docs Using React Styleguidist(20)

Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose preso by Elad Elrom
Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose presoTest Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose preso
Test Driven Development (TDD) with FlexUnit 4 - 360|Flex San Jose preso
Elad Elrom2.7K views
Test Driven Development (TDD) Preso 360|Flex 2010 by guest5639fa9
Test Driven Development (TDD) Preso 360|Flex 2010Test Driven Development (TDD) Preso 360|Flex 2010
Test Driven Development (TDD) Preso 360|Flex 2010
guest5639fa9536 views
Turku loves-storybook-styleguidist-styled-components by James Stone
Turku loves-storybook-styleguidist-styled-componentsTurku loves-storybook-styleguidist-styled-components
Turku loves-storybook-styleguidist-styled-components
James Stone489 views
Front-End Modernization for Mortals by cgack
Front-End Modernization for MortalsFront-End Modernization for Mortals
Front-End Modernization for Mortals
cgack400 views
Front end-modernization by devObjective
Front end-modernizationFront end-modernization
Front end-modernization
devObjective368 views
How To Navigate And Extend The Flex Infrastructure by michael.labriola
How To Navigate And Extend The Flex InfrastructureHow To Navigate And Extend The Flex Infrastructure
How To Navigate And Extend The Flex Infrastructure
michael.labriola749 views
Neo4j Stored Procedure Training Part 1 by Max De Marzi
Neo4j Stored Procedure Training Part 1Neo4j Stored Procedure Training Part 1
Neo4j Stored Procedure Training Part 1
Max De Marzi4.3K views
Iterating In the Open by Dave Hodson
Iterating In the OpenIterating In the Open
Iterating In the Open
Dave Hodson425 views
Atlassian summit comes to you - London AUG by Beejal Nagar
Atlassian summit comes to you - London AUGAtlassian summit comes to you - London AUG
Atlassian summit comes to you - London AUG
Beejal Nagar261 views
Biml for Beginners: Script and Automate SSIS development (24 Hours of PASS: S... by Cathrine Wilhelmsen
Biml for Beginners: Script and Automate SSIS development (24 Hours of PASS: S...Biml for Beginners: Script and Automate SSIS development (24 Hours of PASS: S...
Biml for Beginners: Script and Automate SSIS development (24 Hours of PASS: S...
Cathrine Wilhelmsen1.1K views
Building Forio Web Simulations - Introduction to Interface Design by foriocorp
Building Forio Web Simulations - Introduction to Interface DesignBuilding Forio Web Simulations - Introduction to Interface Design
Building Forio Web Simulations - Introduction to Interface Design
foriocorp588 views
STSADM Automating SharePoint Administration - Tech Ed South East Asia 2008 wi... by Joel Oleson
STSADM Automating SharePoint Administration - Tech Ed South East Asia 2008 wi...STSADM Automating SharePoint Administration - Tech Ed South East Asia 2008 wi...
STSADM Automating SharePoint Administration - Tech Ed South East Asia 2008 wi...
Joel Oleson1.3K views
Better User Experience with .NET by Peter Gfader
Better User Experience with .NETBetter User Experience with .NET
Better User Experience with .NET
Peter Gfader1.3K views

More from James Stone

Treeshaking your CSS by
Treeshaking your CSSTreeshaking your CSS
Treeshaking your CSSJames Stone
288 views22 slides
Living Styleguides: Build Your Own Bootstrap by
Living Styleguides: Build Your Own BootstrapLiving Styleguides: Build Your Own Bootstrap
Living Styleguides: Build Your Own BootstrapJames Stone
664 views18 slides
ZURB Foundation 5: Clean + Organized by
ZURB Foundation 5: Clean + OrganizedZURB Foundation 5: Clean + Organized
ZURB Foundation 5: Clean + OrganizedJames Stone
3.3K views37 slides
Wordpress -> Middleman: Lesson learned in the 2-years since migrating by
Wordpress -> Middleman: Lesson learned in the 2-years since migratingWordpress -> Middleman: Lesson learned in the 2-years since migrating
Wordpress -> Middleman: Lesson learned in the 2-years since migratingJames Stone
1.3K views14 slides
ZURB Foundation 5 -- Understanding the Ecosystem by
ZURB Foundation 5 -- Understanding the EcosystemZURB Foundation 5 -- Understanding the Ecosystem
ZURB Foundation 5 -- Understanding the EcosystemJames Stone
447 views16 slides
Canvas Only: Creative Coding in HTML5 by
Canvas Only: Creative Coding in HTML5Canvas Only: Creative Coding in HTML5
Canvas Only: Creative Coding in HTML5James Stone
1.9K views32 slides

More from James Stone(6)

Treeshaking your CSS by James Stone
Treeshaking your CSSTreeshaking your CSS
Treeshaking your CSS
James Stone288 views
Living Styleguides: Build Your Own Bootstrap by James Stone
Living Styleguides: Build Your Own BootstrapLiving Styleguides: Build Your Own Bootstrap
Living Styleguides: Build Your Own Bootstrap
James Stone664 views
ZURB Foundation 5: Clean + Organized by James Stone
ZURB Foundation 5: Clean + OrganizedZURB Foundation 5: Clean + Organized
ZURB Foundation 5: Clean + Organized
James Stone3.3K views
Wordpress -> Middleman: Lesson learned in the 2-years since migrating by James Stone
Wordpress -> Middleman: Lesson learned in the 2-years since migratingWordpress -> Middleman: Lesson learned in the 2-years since migrating
Wordpress -> Middleman: Lesson learned in the 2-years since migrating
James Stone1.3K views
ZURB Foundation 5 -- Understanding the Ecosystem by James Stone
ZURB Foundation 5 -- Understanding the EcosystemZURB Foundation 5 -- Understanding the Ecosystem
ZURB Foundation 5 -- Understanding the Ecosystem
James Stone447 views
Canvas Only: Creative Coding in HTML5 by James Stone
Canvas Only: Creative Coding in HTML5Canvas Only: Creative Coding in HTML5
Canvas Only: Creative Coding in HTML5
James Stone1.9K views

Recently uploaded

Antimalarial agents-Medicinal Chemistry by
Antimalarial agents-Medicinal ChemistryAntimalarial agents-Medicinal Chemistry
Antimalarial agents-Medicinal ChemistryNarminHamaaminHussen
7 views27 slides
IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdf by
IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdfIEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdf
IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdfNirmalanGanapathy1
12 views36 slides
Essay 29.docx by
Essay 29.docxEssay 29.docx
Essay 29.docxOrlySiquihua
5 views1 slide
StratPlanning Manual 220713.pdf by
StratPlanning Manual 220713.pdfStratPlanning Manual 220713.pdf
StratPlanning Manual 220713.pdfLakewalk Media
19 views43 slides
Using Experiential Design to Understand the Future of AI & Immersive Storytel... by
Using Experiential Design to Understand the Future of AI & Immersive Storytel...Using Experiential Design to Understand the Future of AI & Immersive Storytel...
Using Experiential Design to Understand the Future of AI & Immersive Storytel...Kent Bye
13 views114 slides
Oregon Ducks 4 Spencer Webb Hoodie by
Oregon Ducks 4 Spencer Webb HoodieOregon Ducks 4 Spencer Webb Hoodie
Oregon Ducks 4 Spencer Webb Hoodiebrandshop1
13 views1 slide

Recently uploaded(20)

IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdf by NirmalanGanapathy1
IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdfIEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdf
IEC 600068-2-39 ENVIROMENT TESTING COMBINED TEMPERATURE LOW HUMIDTY.pdf
StratPlanning Manual 220713.pdf by Lakewalk Media
StratPlanning Manual 220713.pdfStratPlanning Manual 220713.pdf
StratPlanning Manual 220713.pdf
Lakewalk Media19 views
Using Experiential Design to Understand the Future of AI & Immersive Storytel... by Kent Bye
Using Experiential Design to Understand the Future of AI & Immersive Storytel...Using Experiential Design to Understand the Future of AI & Immersive Storytel...
Using Experiential Design to Understand the Future of AI & Immersive Storytel...
Kent Bye13 views
Oregon Ducks 4 Spencer Webb Hoodie by brandshop1
Oregon Ducks 4 Spencer Webb HoodieOregon Ducks 4 Spencer Webb Hoodie
Oregon Ducks 4 Spencer Webb Hoodie
brandshop113 views
DR Portfolio.pptx by robertsd2
DR Portfolio.pptxDR Portfolio.pptx
DR Portfolio.pptx
robertsd214 views
Free World aids day Template from Best presentation design agency by slideceotemplates
Free World aids day Template from Best presentation design agencyFree World aids day Template from Best presentation design agency
Free World aids day Template from Best presentation design agency
The Report is Dead, Long Live the Report ! Communicating Usability Research F... by Centralis
The Report is Dead, Long Live the Report ! Communicating Usability Research F...The Report is Dead, Long Live the Report ! Communicating Usability Research F...
The Report is Dead, Long Live the Report ! Communicating Usability Research F...
Centralis6 views
Business X Design - People, Planet & Product by Cyber-Duck
Business X Design - People, Planet & ProductBusiness X Design - People, Planet & Product
Business X Design - People, Planet & Product
Cyber-Duck19 views
Canned Cocktail Flat Labels by nyhapedraza
Canned Cocktail Flat LabelsCanned Cocktail Flat Labels
Canned Cocktail Flat Labels
nyhapedraza7 views

Easy Bolt-on Docs Using React Styleguidist

  • 2. How to document systems built in react in a reactish way
  • 3. WHY WHY NOT WHY NOT X HOW WHERE
  • 4. THE WHO THE WHAT
  • 6. One way to go pro
  • 8. ZURB Foundation Top Contributor, Certified Preferred, etc.
  • 10. 5 STAGES OF GRIEF 1. Denial 2. Anger 3. Bargaining 4. Depression 5. Acceptance
  • 11. 5 STAGES OF GRIEF source: wikipedia
  • 12. 5 STAGES OF GRIEF WITH ANGULAR 1. Denial I'm just doing this until Vue.js catches on 2. Anger Nested ternaries, button components, CSS in JS 3. Bargaining wix/react-templates 4. Depression Endless videos and tutorials 5. Acceptance I'm now okay, but Functional Programing...
  • 13. WHY A LIVING STYLEGUIDE 1. Foster better communication 2. Play to your team's strengths 3. Avoid conflict between teams 4. Produce a better quality product 5. More design consistency 6. Less meetings source: Design Systems Crash Course
  • 14. In my experience there are two ways to get started with creating a Design System that will work for an organization of any size. Even a web team of one. ‣ Front-end Code ‣ Living Styleguide source: Design Systems Crash Course
  • 15. Both of these are what I like to call low hanging fruit. This means that you will be able to build these the fastest, with the least amount of effort and they will have the biggest rewards. source: Design Systems Crash Course
  • 16. WHY NOT X STORYBOOK ‣ You write stories in JavaScript files (vs md) ‣ How you describe components ‣ Shows only one variation at a time (vs. multiple) source: React Styleguidist Cookbook
  • 17. REACT STLYEGUIDIST GIVES YOU ‣ Auto public method docs ‣ All components on a single page (Styleguide) ‣ Extra docs added (Design System or More complete docs) ‣ Can be branded (customizable design) ‣ You get some docs auto generated*
  • 18. STORYBOOK EXAMPLE import React from "react"; import { storiesOf } from "@storybook/react"; import { action } from "@storybook/addon-actions"; import Button from "../components/Button"; storiesOf("Button", module).add("default", () => ( <Button onClick={action("clicked")}>Push Me</Button> ));
  • 19. REACT STYLEGUIDIST EXAMPLE ```js <Button onClick={() => console.log('clicked')>Push Me</Button> ```
  • 20. REACT STYLEGUIDIST EXAMPLE (FENCES REMOVED) <Button onClick={() => console.log('clicked')>Push Me</Button>
  • 21. HOW REDUX TODO MVC EXAMPLE