diff --git a/.github/contribution/docs.md b/.github/contribution/docs.md index 5e91803812..6b7a3163bc 100644 --- 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/.github/styles/Kiwi/AMPM.yml b/.github/styles/Kiwi/AMPM.yml deleted file mode 100644 index 5c9b2d1c96..0000000000 --- a/.github/styles/Kiwi/AMPM.yml +++ /dev/null @@ -1,9 +0,0 @@ -extends: existence -message: "Use a 24-hour clock (for example: 23:43)." -link: 'https://orbit.kiwi/content/grammar-and-mechanics/#currency' -level: error -nonword: true -tokens: - - '\d{1,2}[aApP][Mm]' - - '\d{1,2} ?[aApP][Mm]' - - '\d{1,2} ?[aApP]\.[mM]\.' diff --git a/.github/styles/Kiwi/Abbreviations.yml b/.github/styles/Kiwi/Abbreviations.yml deleted file mode 100644 index 177eb0461a..0000000000 --- a/.github/styles/Kiwi/Abbreviations.yml +++ /dev/null @@ -1,64 +0,0 @@ -extends: conditional -message: "Spell out '%s', if it's unfamiliar to the audience." -link: 'https://developers.google.com/style/abbreviations' -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-zA-Z]+ )+\(([A-Z]{3,5})\)' -# ... with the exception of these: -exceptions: - - API - - ASP - - CLI - - CPU - - CSS - - CSV - - DEBUG - - DOM - - DPI - - FAQ - - GCC - - GDB - - GET - - GPU - - GTK - - GUI - - HTML - - HTTP - - HTTPS - - IDE - - JAR - - JSON - - JSX - - LESS - - LLDB - - NET - - NOTE - - NVDA - - OSS - - PATH - - PDF - - PHP - - POST - - RAM - - REPL - - RSA - - SCM - - SCSS - - SDK - - SQL - - SSH - - SSL - - SVG - - TBD - - TCP - - TODO - - URI - - URL - - USB - - UTF - - XML - - XSS - - YAML - - ZIP diff --git a/.github/styles/Kiwi/Britishisms.yml b/.github/styles/Kiwi/Britishisms.yml deleted file mode 100644 index 34dcb82224..0000000000 --- a/.github/styles/Kiwi/Britishisms.yml +++ /dev/null @@ -1,91 +0,0 @@ -extends: substitution -message: "Use the American spelling '%s' instead of '%s'." -link: 'https://orbit.kiwi/content/grammar-and-mechanics/#spelling' -ignorecase: true -level: warning -action: - name: replace -swap: - aeroplane: airplane - ageing: aging - aluminium: aluminum - analogue: analog - analyse: analyze - analysed: analyzed - annexe: annex - apologise: apologize - behaviour: behavior - busses: buses - centre: center - cheque: check - civilisation: civilization - civilise: civilize - colour: color - cosy: cozy - cypher: cipher - dependant: dependent - defence: defense - dialogue: dialog - draught: draft - enquiry: inquiry - enrol: enroll - enrolment: enrollment - favourite: favorite - fibre: fiber - flavour: flavor - focussed: focused - fuelled: fueled - fuelling: fueling - fulfil: fulfill - grey: gray - humour: humor - honour: honor - initialled: initialed - initialling: initialing - instil: instill - jewellery: jewelry - labelling: labeling - labelled: labeled - labour: labor - licence: license - likeable: likable - litre: liter - liveable: livable - metre: meter - modelling: modeling - moustache: mustache - neighbour: neighbor - normalise: normalize - offence: offense - organisation: organization - organise: organize - organised: organized - organising: organizing - orientated: oriented - paralyse: paralyze - plough: plow - practise: practice - pretence: pretense - programme: program - pyjamas: pajamas - rateable: ratable - realise: realize - realised: realized - recognise: recognize - recognised: recognized - rumour: rumor - saleable: salable - sceptic: skeptic - signalling: signaling - sizeable: sizable - skilful: skillful - speciality: specialty - standardise: standardize - standardised: standardized - theatre: theater - travelled: traveled - traveller: traveler - travelling: traveling - unshakeable: unshakable - wilful: willful - yoghurt: yogurt diff --git a/.github/styles/Kiwi/CommonErrors.yml b/.github/styles/Kiwi/CommonErrors.yml deleted file mode 100644 index 2eeb0c78f8..0000000000 --- a/.github/styles/Kiwi/CommonErrors.yml +++ /dev/null @@ -1,12 +0,0 @@ -extends: substitution -message: "Use '%s' instead of '%s'." -link: 'https://orbit.kiwi/content/grammar-and-mechanics/#spelling' -ignorecase: true -level: warning -action: - name: replace -swap: - comprise of: comprise - comprises of: comprises - reason why: reason - way how: way \ No newline at end of file diff --git a/.github/styles/Kiwi/Contractions.yml b/.github/styles/Kiwi/Contractions.yml deleted file mode 100644 index 6719de23b0..0000000000 --- a/.github/styles/Kiwi/Contractions.yml +++ /dev/null @@ -1,29 +0,0 @@ -extends: existence -message: "Feel free to use a contraction instead of '%s': - https://orbit.kiwi/content/technical-content/language/#use-contractions" -link: https://orbit.kiwi/content/technical-content/language/#use-contractions -level: suggestion -ignorecase: true -scope: raw -tokens: - - are not - - cannot - - could not - - did not - - do not - - does not - - has not - - have not - - is not - - (? - [https://images.kiwi.com/orbit-icons/success/48×48/airplane.png](https://images.kiwi.com/orbit-icons/success/48x48/airplane.png) - - 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 index 87d2558562..d72560a53e 100644 --- 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. - - ## Favicons - - ## Brand color These are the basic palette colors. diff --git a/docs/src/documentation/06-kiwi-use/02-content/01-voice-and-tone/03-straightforward.mdx b/docs/src/documentation/06-kiwi-use/02-content/01-voice-and-tone/03-straightforward.mdx index e1a7f94337..beb71b3757 100644 --- a/docs/src/documentation/06-kiwi-use/02-content/01-voice-and-tone/03-straightforward.mdx +++ b/docs/src/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. - - @@ -58,8 +56,6 @@ Avoid general terms like "stuff" to substitute for actually explaining what you' - - ### 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 index 4ea6c38648..3352782e1b 100644 --- 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. - - @@ -69,8 +67,6 @@ Slang can be harder for people with English as a second language to understand. - - ## 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 index 74e89dab7d..735c0170f4 100644 --- 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". - - @@ -38,8 +36,6 @@ Unless there is a very good reason to do so, avoid using "we" and "our". - - ## 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. - - @@ -70,8 +64,6 @@ Similarly, avoid "would" and "could" - - ## 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 - - 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 - - diff --git a/docs/src/pages/component-status.mdx b/docs/src/pages/component-status.mdx index 45b59a7296..247049604a 100644 --- 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"; - - export default ({ children, location }) => { return ( { ); }; - - 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 index 727245dbb5..0eefb2f859 100644 --- 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"; - - export default ({ children, location }) => { return ( { ); }; - - 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.