docs: remove vale references

kiwicom · Nov 15, 2024 · 22ce3f9 · 22ce3f9
1 parent 6bc51fb
commit 22ce3f9
Show file tree

Hide file tree

Showing 8 changed files with 0 additions and 53 deletions.
diff --git a/.github/contribution/docs.md b/.github/contribution/docs.md
@@ -103,23 +103,6 @@ and not formatting.
 This style is known as ventilated prose.
 Read [more about the reasons to use it](https://asciidoctor.org/docs/asciidoc-recommended-practices/#one-sentence-per-line).
 
-## Prose style
-
-In addition to the linting for code style in our docs,
-we also lint to ensure the docs follow our [style guide](https://orbit.kiwi/content/voice-tone/)
-as much as possible.
-
-For this, we use [Vale](https://docs.errata.ai/vale/about).
-Our specifics can be found in the [styles directory](../styles),
-with rules in the `Kiwi` folder and accepted spellings in [accept.txt](../styles/Vocab/Kiwi/accept.txt).
-
-To check your prose yourself, [install Vale](https://docs.errata.ai/vale/install).
-Or you can create a pull request
-and the Vale GitHub Action adds comments pointing out places that could be improved.
-
-The rules aren't perfect at detecting problems,
-so feel free to ignore any suggestions that seem wrong.
-
 ## Checking links
 
 It's important for working documentation to have working links.

diff --git a/docs/src/documentation/02-foundation/07-icons/02-cdn.mdx b/docs/src/documentation/02-foundation/07-icons/02-cdn.mdx
@@ -23,8 +23,4 @@ Fill in the details as follows:
 
 So for a success version in large of an airplane icon, you'd use the following address:
 
-<!-- vale Vale.Spelling = NO -->
-
 [https://images.kiwi.com/orbit-icons/success/48×48/airplane.png](https://images.kiwi.com/orbit-icons/success/48x48/airplane.png)
-
-<!-- vale Vale.Spelling = YES -->
diff --git a/docs/src/documentation/06-kiwi-use/01-brand/brand-guidelines/01-kiwi-com.mdx b/docs/src/documentation/06-kiwi-use/01-brand/brand-guidelines/01-kiwi-com.mdx
@@ -149,8 +149,6 @@ it breathe.
 
 Logos used online should be at least 32 pixels high.
 
-<!-- vale Vale.Spelling = NO -->
-
 ## Favicons
 
 <FancyLink
@@ -160,8 +158,6 @@ Logos used online should be at least 32 pixels high.
   download
 />
 
-<!-- vale Vale.Spelling = YES -->
-
 ## Brand color
 
 These are the basic palette colors.

diff --git a/...c/documentation/06-kiwi-use/02-content/01-voice-and-tone/03-straightforward.mdx b/...c/documentation/06-kiwi-use/02-content/01-voice-and-tone/03-straightforward.mdx
@@ -36,8 +36,6 @@ It's fine to use contractions like "it's" as long as it's clear what you mean.
 
 Avoid general terms like "stuff" to substitute for actually explaining what you're talking about.
 
-<!-- vale Kiwi.Abbreviations = NO -->
-
 <GuidelinesSideBySide>
 
 <Do>
@@ -58,8 +56,6 @@ Avoid general terms like "stuff" to substitute for actually explaining what you'
 
 </GuidelinesSideBySide>
 
-<!-- vale Kiwi.Abbreviations = NO -->
-
 ### Structure what you write
 
 [Studies have shown](https://www.nngroup.com/articles/how-people-read-online/)

diff --git a/docs/src/documentation/06-kiwi-use/02-content/01-voice-and-tone/05-inclusive.mdx b/docs/src/documentation/06-kiwi-use/02-content/01-voice-and-tone/05-inclusive.mdx
@@ -49,8 +49,6 @@ Write using more **universal language**.
 
 Slang can be harder for people with English as a second language to understand.
 
-<!-- vale Kiwi.Abbreviations = NO -->
-
 <GuidelinesSideBySide>
 
 <Do>
@@ -69,8 +67,6 @@ Slang can be harder for people with English as a second language to understand.
 
 </GuidelinesSideBySide>
 
-<!-- vale Kiwi.Abbreviations = YES -->
-
 ## Be inclusive
 
 We write so everyone feels a part of what we're saying.

diff --git a/docs/src/documentation/06-kiwi-use/02-content/05-technical-content/04-language.mdx b/docs/src/documentation/06-kiwi-use/02-content/05-technical-content/04-language.mdx
@@ -16,8 +16,6 @@ Be clear and to the point.
 
 Unless there is a very good reason to do so, avoid using "we" and "our".
 
-<!-- vale Kiwi.Direct = NO -->
-
 <GuidelinesSideBySide>
 
 <Do>
@@ -38,8 +36,6 @@ Unless there is a very good reason to do so, avoid using "we" and "our".
 
 </GuidelinesSideBySide>
 
-<!-- vale Kiwi.Direct = YES -->
-
 ## Tenses
 
 For most [types of documentation](/kiwi-use/content/specific-areas/technical-content/structure/),
@@ -48,8 +44,6 @@ Use the present tense to describe actions.
 Similarly, avoid "would" and "could"
 (and any other modals expressing uncertainty) in conditional statements.
 
-<!-- vale Kiwi.Will = NO -->
-
 <GuidelinesSideBySide>
 
 <Do>
@@ -70,8 +64,6 @@ Similarly, avoid "would" and "could"
 
 </GuidelinesSideBySide>
 
-<!-- vale Kiwi.Will = YES -->
-
 ## Creating links
 
 When inserting links into the text,
@@ -168,8 +160,6 @@ That structure should be enough, so the headings shouldn't be numbered.
 
 ## Use contractions
 
-<!-- vale Kiwi.Contractions = NO -->
-
 In keeping with our being [empathetic](/kiwi-use/content/voice-and-tone/empathetic/#use-words-and-structures-youd-use-in-speaking),
 feel free to use common contractions.
 This means writing _can't_ and _isn't_ in place of _cannot_ and _are not_.
@@ -199,5 +189,3 @@ But common contractions such as _it's_ should be clear (just don't confuse _it's
 </Dont>
 
 </GuidelinesSideBySide>
-
-<!-- vale Kiwi.Contractions = YES -->
diff --git a/docs/src/pages/component-status.mdx b/docs/src/pages/component-status.mdx
@@ -1,8 +1,6 @@
 import { ComponentStatusList } from "../components/ComponentStatus";
 import DocLayout from "../components/DocLayout";
 
-<!-- vale off -->
-
 export default ({ children, location }) => {
   return (
     <DocLayout
@@ -16,8 +14,6 @@ export default ({ children, location }) => {
   );
 };
 
-<!-- vale on -->
-
 This listing reflects the current state of our components.
 
 The individual phases don't directly depend on one another.

diff --git a/docs/src/pages/mdx-examples.mdx b/docs/src/pages/mdx-examples.mdx
@@ -3,8 +3,6 @@ import { Meal } from "@kiwicom/orbit-components/icons";
 import DocLayout from "../components/DocLayout";
 import Palette from "../components/Palette";
 
-<!-- vale off -->
-
 export default ({ children, location }) => {
   return (
     <DocLayout
@@ -18,8 +16,6 @@ export default ({ children, location }) => {
   );
 };
 
-<!-- vale on -->
-
 This page includes examples of all components shared across our docs files.
 See them all in action in the built page
 or view the source to see how use them.