fix(docs): fix errors in prose

.eslintrc.js

@@ -216,6 +216,7 @@ module.exports = {
         // Ignore components added as shortcodes so they don't get marked as undefined
         // TODO: remove the components that aren't shortcodes, just haven't been added yet
         Callout: false,
+        ComponentStatus: false,
         Do: false,
         Dont: false,
         FancyLink: false,

.github/styles/Kiwi/Acronyms.yml → .github/styles/Kiwi/Abbreviations.yml

@@ -5,7 +5,7 @@ level: suggestion
 ignorecase: false
 # Ensures that the existence of 'first' implies the existence of 'second'.
 first: '\b([A-Z]{3,5})\b'
-second: '(?:\b[a-z]+ )+\(([A-Z]{3,5})\)'
+second: '(?:\b[a-zA-Z]+ )+\(([A-Z]{3,5})\)'
 # ... with the exception of these:
 exceptions:
   - API

.github/styles/Kiwi/Contractions.yml

@@ -26,3 +26,4 @@ swap:
   when is: when's
   where is: where's
   will not: won't
+  you are: you're

.github/styles/Kiwi/EmDash.yml

@@ -4,5 +4,7 @@ link: 'https://orbit.kiwi/content/grammar-and-mechanics/#punctuation'
 scope: paragraph
 level: error
 tokens:
-  - '(?<!\s)[—–](?!\s)'
-  - '(?<!\s)---(?!\s)'
+  - '\s[—–]'
+  - '[—–]\s'
+  - '\s---'
+  - '---\s'

.github/styles/Kiwi/Will.yml

@@ -6,3 +6,4 @@ level: warning
 tokens:
   - will
   - won't
+  - \'ll

.github/styles/Vocab/Kiwi/accept.txt

@@ -1,14 +1,44 @@
+Autoflow
+bitz
 Callout
+Cmd
+composable
+composability
+Ctrl
+[Dv]ev
 [Ff]igma
+Filip
+Funkify
+Genaev
+Hapl
+inclusivity
 JavaScript
+KLM
 Kiwi.com
+Lato
+Lerna
 MDX
 MMB
+Matija
+monorepo
+npm
 Okta
+overcomplicate
+Pantone
+Photoshop
 px
+radiuses
+repos
 Roboto
+[Rr]untime
+Ryanair
+Skypicker
+Spitzer
 Tequila
+Themer
+[Tt]ooltip
+[Tt]ooltips
 tl
-Ryanair
-KLM
+Toman
+viewport
 Vueling

.remarkrc.js

@@ -1,7 +1,7 @@
 exports.plugins = [
   ["frontmatter", ["yaml"]],
+  ["lint-first-heading-level", 2],
   "preset-lint-markdown-style-guide",
   "preset-lint-recommended",
   "preset-prettier",
-  ["lint-first-heading-level", 2],
 ];

.vale.ini

@@ -4,7 +4,14 @@ Vocab = Kiwi
 
 MinAlertLevel = suggestion # suggestion, warning, or error
 
+[formats]
+mdx = md
+
 # Which files shold be checked
 [*.{md,mdx}]
+
 # List of styles to load.
 BasedOnStyles = Kiwi, Vale
+
+# Ignore import statements
+TokenIgnores = (import .* from ".*";)

docs/src/components/ElevationLevel.tsx

@@ -4,9 +4,9 @@ import styled, { css } from "styled-components";
 import theme from "../theme";
 
 interface LevelDivProps {
-  boxShadow: string;
   backgroundColor: string;
   border: string;
+  boxShadow: string;
 }
 
 export const LevelDiv = styled.div<LevelDivProps>`
@@ -21,7 +21,11 @@ export const LevelDiv = styled.div<LevelDivProps>`
   `}
 `;
 
-export default ({ level }) => {
+interface ElevationLevelProps {
+  level: 1 | 2 | 3 | 3.5 | 4 | 4.5 | 5 | 5.5 | 6;
+}
+
+export default ({ level }: ElevationLevelProps) => {
   let backgroundColor = theme.orbit.paletteWhite;
   let border = "none";
   let boxShadow = "none";

docs/src/components/Github/data.json

@@ -7,7 +7,7 @@
     "dribbble": "",
     "github": "https://github.com/CollierCZ",
     "twitter": "",
-    "website": ""
+    "website": "https://collier.cz/"
   },
   {
     "id": "will",
@@ -32,7 +32,7 @@
   {
     "id": "vepor",
     "name": "Luděk Vepřek",
-    "info": "Luděk leads our team. He is responsible for cross-platform API consistency between different implementations of Orbit components",
+    "info": "Luděk leads our team. He is responsible for cross-platform API consistency between different implementations of Orbit components.",
     "position": "Engineering Lead",
     "dribbble": "",
     "github": "https://github.com/vepor",

docs/src/components/Placeholder.tsx

@@ -0,0 +1,2 @@
+const Placeholder = ({ children }) => children;
+export default Placeholder;

docs/src/documentation/01-getting-started/01-for-designers/01-kiwi.mdx

@@ -14,7 +14,7 @@ We use Figma for all our entire design workflow.
 Since it's a larger topic,
 we've set up a set of guides on [working with Figma](https://orbit.kiwi/?page_id=7603).
 
-- If you run into any issues, use the **\#plz-figma** channel on Slack.
+- If you run into any issues, use the **#plz-figma** channel on Slack.
 
 ## Fonts
 

docs/src/documentation/01-getting-started/01-for-designers/02-open-source.mdx

@@ -11,36 +11,32 @@ we provide our Figma UI kit as files for you to download.
 
 To access our library, duplicate the files you can find at our community profile.
 
-<FancyLink
-  title="Orbit Figma profile"
-  href="https://figma.com/@OrbitByKiwi"
-  icon="figma"
-/>
+<FancyLink title="Orbit Figma profile" href="https://figma.com/@OrbitByKiwi" icon="figma" />
 
-These will appear as in your Drafts.
+These appear in your Drafts.
 Now you can work with them to create your own designs.
 
 If you have a team plan, you can also use the files as a library.
 See the [Figma docs for how to publish the files to a library](https://help.figma.com/hc/en-us/articles/360025508373).
 
 <Callout type="warning">
 
-Currently, Figma does not provide notifications when our public files are updated.
+Currently, Figma doesn't provide notifications when our public files are updated.
 To make sure you stay up to date, check the _Last updated_ date on the files at our community profile
 and [follow us on Twitter](https://twitter.com/OrbitKiwi).
 
 </Callout>
 
 ## Font
 
-By default, our libraries use Circular Pro, which is not an open font.
+By default, our libraries use Circular Pro, which isn't an open font.
 If you have a license for Circular Pro, you can use Orbit with Circular Pro.
 
 <Callout type="warning">
 
-Don't forget to [buy a license](https://lineto.com/the+fonts/font+categories/text+fonts/circular/) for your domains.
+Don't forget to [buy a license](https://lineto.com/the+fonts/font+categories/text+fonts/circular/) for your domains.
 
 </Callout>
 
-If you do not have a license, you can replace it with Roboto, a free font from Google.
+If you don't have a license, you can replace it with Roboto, a free font from Google.
 You can [download Roboto from Google Fonts](https://fonts.google.com/specimen/Roboto).

docs/src/documentation/01-getting-started/02-for-developers.mdx

@@ -5,7 +5,7 @@ excerpt: Our components are served as an npm package.
 
 [![orbit-components](https://orbit.kiwi/files/orbit-components.png)](https://orbit.kiwi)
 
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
+[![Lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
 
 **Orbit-components is a React component library which provides developers with the easiest possible way of building Kiwi.com products.**
 
@@ -88,7 +88,7 @@ yarn add @types/styled-components -D
 
 ## Contributing
 
-We are working on making this project a fully open source.
+We're working on making this project a fully open source.
 e appreciate any contributions you might make.
 
 [Bug reports](https://github.com/kiwicom/orbit/issues/new?template=bug_report.md) and [feature requests](https://github.com/kiwicom/orbit/issues/new?template=feature_request.md) are welcome,

docs/src/documentation/01-getting-started/03-github.mdx

@@ -3,31 +3,27 @@ title: GitHub repos & resources
 excerpt: List of repositories related to Orbit design system.
 ---
 
-## Github Repositories
+## GitHub monorepo
 
-All Orbit Github repositories are public and available as NPM packages.
-
-### Orbit monorepo
-
-Orbit has a single repository that contains all the important packages.
+Orbit has a single repository that contains all important packages
+(available via npm) and documentation.
 
 <FancyLink title="Orbit monorepo" href="https://github.com/kiwicom/orbit/" icon="github" />
 
-#### React components
+### React components
 
-The Orbit Components package stores all React components along with API
-documentation.
+The Orbit Components package stores all React components
+along with API documentation.
 
 <FancyLink
   title="Orbit Components"
   href="https://github.com/kiwicom/orbit/tree/master/packages/orbit-components"
   icon="github"
 />
 
-#### Orbit Design Tokens
+### Orbit Design Tokens
 
 The Orbit Design Tokens package stores all visual UI attributes.
-Available as an npm package.
 
 <FancyLink
   title="Orbit Design Tokens"
@@ -37,8 +33,8 @@ Available as an npm package.
 
 ## React Storybook
 
-Orbit Storybook provides a preview of all React components, together
-with the possibility to play with different variations and settings.
+Orbit Storybook provides a preview of all React components,
+together with the possibility to play with different variations and settings.
 
 <FancyLink
   title="Orbit Storybook Playground"
@@ -48,7 +44,7 @@ with the possibility to play with different variations and settings.
 
 ## Orbit Themer
 
-Orbit Themer is a visual tool that helps you set color palettes and
-generates object required for getTokens function.
+Orbit Themer is a visual tool that helps you set color palettes
+and generates the object required for the getTokens function.
 
 <FancyLink title="Orbit Themer" href="https://themer.orbit.kiwi" icon="color-picker" />

docs/src/documentation/01-getting-started/04-support/01-kiwi.mdx

@@ -3,56 +3,52 @@ title: For Kiwi.com
 ---
 
 Slack is Kiwi.com's main platform for communication,
-so it's only understandable that everything important that is happening around Orbit is also on Slack.
+so it's only understandable that everything important that's happening around Orbit is also on Slack.
 
 ## Slack
 
 ### Groups
 
-We also have four groups you can use to tag members of Orbit team:
+We have groups you can use to tag members of the Orbit team:
 
-- **\@orbit** -- tags all Orbit members
-- **\@orbitdesign** -- tags all designers behind Orbit
-- **\@orbitreact** -- tags all React maintainers of Orbit components
-- **\@orbitdocs** -- tags all maintainers of Orbit documentation
+- **@orbit**: tags all Orbit members
+- **@orbitdesign**: tags all designers behind Orbit
+- **@orbitdevs**: tags all maintainers of Orbit components
 
 ### Channels
 
 See all of our channels and what they're for.
 
-#### \#plz-orbit
+#### `#plz-orbit`
 
 If you need to request some change in Orbit components, Sketch UI kit, etc.,
-this channel is one you are looking for.
+this is the channel you're looking for.
 
-#### \#orbit-announcements
+#### `#orbit-announcements`
 
-The main channel with general information about Orbit -- component releases, updates of Sketch UI library, ...
+The main channel with general information about Orbit:
+component releases, updates to the Figma libraries, and so on.
 
-#### \#orbit-react
+#### `#orbit-react`
 
 The channel where we discuss everything connected to developing Orbit components in React.
 
-#### \#orbit-mobile-native
+#### `#orbit-standup`
 
-The channel where we discuss everything related to the native mobile variation of Orbit.
+Team channel where all team members write their daily activities.
 
-#### \#orbit-standup
-
-Team channel where all team members write their daily standups.
-
-#### \#orbit-documentation
+#### `#orbit-documentation`
 
 The channel where we discuss everything related to documentation.
 
-#### \#orbit-github-log
+#### `#orbit-github-log`
 
-Log of everything that is happening in [Orbit Github repositories](https://orbit.kiwi/getting-started/github-repos-resources/).
+A log of everything that's happening in [Orbit GitHub repositories](https://orbit.kiwi/getting-started/github-repos-resources/).
 
-## Bug reporting on Github
+## Bug reporting on GitHub
 
 If you found any bugs in our components,
-report them [on Github](https://github.com/kiwicom/orbit-components/issues) and we'll fix them asap.
+report them [on GitHub](https://github.com/kiwicom/orbit-components/issues) and we'll fix them asap.
 It's the highest priority to have Orbit working as expected.
 
 <FancyLink

docs/src/documentation/01-getting-started/04-support/02-open-source.mdx

@@ -4,18 +4,18 @@ title: For open source
 
 ## Spectrum.chat
 
-The main open channel for our contact with consumers of our Orbit
-open-source packages is Spectrum.chat. The whole core team is there
-happy to help you with any request you may have.
+Our main open channel for consumers of our Orbit open-source packages is Spectrum.chat.
+The whole core team is there
+and happy to help you with any request you may have.
 
 <FancyLink title="Spectrum support space" href="https://spectrum.chat/orbit" icon="spectrum" />
 
-## Bug reporting on Github
+## Bug reporting on GitHub
 
-If you found any bugs in our components, report them [on
-Github](https://github.com/kiwicom/orbit-components/issues) and we'll
-fix them asap. It's the highest priority to have Orbit working as
-expected.
+If you found any bugs in our components,
+report them [on GitHub](https://github.com/kiwicom/orbit-components/issues)
+and we'll fix them asap.
+It's the highest priority to have Orbit working as expected.
 
 <FancyLink
   title="Report bug"