Skip to content

Commit 79d9838

Browse files
committed
FIX spelling
1 parent d41142d commit 79d9838

File tree

2 files changed

+32
-15
lines changed

2 files changed

+32
-15
lines changed

.spelling

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# markdown-spellcheck spelling configuration file
2+
# Format - lines beginning # are comments
3+
# global dictionary is at the start, file overrides afterwards
4+
# one word per line, to define a file override use ' - filename'
5+
# where filename is relative to this configuration file
6+
addon
7+
1
8+
vue
9+
webcomponents
10+
aurelia
11+
iframe
12+
webpack
13+
addons
14+
styleguide-type
15+
styleguides
16+
angularjs
17+
api

ROADMAP.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
## Table of contents
44

55
- [New features](#new-features)
6-
- [Responsive + multidevice viewports preview.](#responsive--multidevice-viewports-preview)
6+
- [Responsive + multi-device viewports preview.](#responsive--multidevice-viewports-preview)
77
- [Automatic story detection](#automatic-story-detection)
88
- [Theme ability and override core UI components](#theme-ability-and-override-core-ui-components)
99
- [Add a playground addon](#add-a-playground-addon)
1010
- [See multiple (or all) stories in 1 preview.](#see-multiple-or-all-stories-in-1-preview)
11-
- [Deeper level hierachy](#deeper-level-hierachy)
11+
- [Deeper level hierarchy](#deeper-level-hierachy)
1212
- [Supporting other frameworks and libraries](#supporting-other-frameworks-and-libraries)
1313
- [Vue](#vue)
1414
- [Angular](#angular)
@@ -21,13 +21,13 @@
2121
- [Documentation](#documentation)
2222
- [Search & Structure](#search--structure)
2323
- [Better design](#better-design)
24-
- [Record videos and write blogpost on how to tweak storybook](#record-videos-and-write-blogpost-on-how-to-tweak-storybook)
24+
- [Record videos and write blog post on how to tweak storybook](#record-videos-and-write-blogpost-on-how-to-tweak-storybook)
2525

2626
## New features
2727

2828
Doing these will be backwards compatible.
2929

30-
### Responsive + multidevice viewports preview.
30+
### Responsive + multi-device viewports preview.
3131

3232
If you're smart about it you can already view the preview on multiple devices and windows. It's just an iframe after-all.
3333
But story selection and addon-settings are not synced.
@@ -41,27 +41,27 @@ We think such a feature is highly needed. A lot of users are already hacking thi
4141
### Theme ability and override core UI components
4242

4343
Storybook is often used inside product companies and agencies. We want to help them have a sense of quality and immersion.
44-
We're interested in full constimizability of our UI, though addons and options.
44+
We're interested in full customizability of our UI, though addons and options.
4545

4646
### Add a playground addon
4747

4848
Many other styleguide-type projects have what's called a playground, where developers can change the code rendering the component inside the app.
49-
Storybook has ofcourse a very tight connection with your editor, and it has a knobs addon.
49+
Storybook has of course a very tight connection with your editor, and it has a knobs addon.
5050
But we still see value in an addon that will allow the workflow of a playground.
5151

5252
### See multiple (or all) stories in 1 preview.
5353

54-
Storybook's philosophy is about describing small bits in a variaty of states.
55-
However some components are best understood when viewed in multiple variaties in 1 view.
54+
Storybook's philosophy is about describing small bits in a variety of states.
55+
However some components are best understood when viewed in multiple varieties in 1 view.
5656
It's quite common to see users write a single story, with a wrapper components and multiple instances of the component the story is about.
5757
We plan to add a second mode to storybook that will allow you to see all stories in 1 preview.
5858
That way you can write your stories how they are best, and preview them how you like.
5959

60-
### Deeper level hierachy
60+
### Deeper level hierarchy
6161

62-
A very long standing issue is about "what about larger styleguides?". Some stylguides have lots and lots of components.
62+
A very long standing issue is about "what about larger styleguides?". Some styleguides have lots and lots of components.
6363
At some point is becomes unmaintainable if you do not group them somehow.
64-
Storybook's UI is not exaclty setup for very large styleguides, right now.
64+
Storybook's UI is not exactly setup for very large styleguides, right now.
6565
But we are going to add a way of defining groups! And develop a UI that allows you to quickly navigate to other groups / stories.
6666

6767
## Supporting other frameworks and libraries
@@ -96,7 +96,7 @@ Please contact us if you want this.
9696

9797
### Addon API
9898

99-
Our addon api is limited and will eventually have to be improved to acommodate better more optimized and modern addons.
99+
Our addon api is limited and will eventually have to be improved to accommodate better more optimized and modern addons.
100100

101101
### API for adding stories
102102

@@ -108,13 +108,13 @@ We want to support this, but will likely mean we will have to change the `add` m
108108
### Search & Structure
109109

110110
Finding the right part of our documentation isn't easy, since there is no search.
111-
We want to intergrate the readme of the individual packages into the documentation site and also have the changelog, contributing, migration and roadmap findable there.
111+
We want to integrate the readme of the individual packages into the documentation site and also have the changelog, contributing, migration and roadmap findable there.
112112

113113
### Better design
114114

115-
We have a new logo, so next step is a overheal of our documentation site.
115+
We have a new logo, so next step is a overhaul of our documentation site.
116116

117-
### Record videos and write blogpost on how to tweak storybook
117+
### Record videos and write blog post on how to tweak storybook
118118

119119
This may include writing addons, choosing the right addons etc.
120120
Also how to start developing on our codebase.

0 commit comments

Comments
 (0)