Introduce text linting of our documentation

[literat]

Description

Linting text content of our documentation files. Only part of the packages are linted due to the changes.

Additional context

https://github.com/lmc-eu/code-quality-tools/blob/main/packages/textlint-rule-preset-lmc/index.js

Applied rules:

• Use correct terms: https://github.com/sapegin/textlint-rule-terminology
• Stop words: https://github.com/sapegin/textlint-rule-stop-words
• Common misspellings: https://github.com/io-monad/textlint-rule-common-misspellings
• Write good in English: https://github.com/textlint-rule/textlint-rule-write-good
• Title Case: https://github.com/sapegin/textlint-rule-title-case

Most changes:

• e.g. -> for example
• i.e. -> that is
• normalization of apostrophes to '
• if you want to -> to

Issue reference

https://jira.almacareer.tech/browse/DS-1496

[netlify]

✅ Deploy Preview for spirit-design-system ready!

Name	Link
🔨 Latest commit	ac0dcf3
🔍 Latest deploy log	https://app.netlify.com/sites/spirit-design-system/deploys/678130ae60760a000889299b
😎 Deploy Preview	https://deploy-preview-1588--spirit-design-system.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 96 (no change from production) Accessibility: 91 (no change from production) Best Practices: 100 (no change from production) SEO: 91 (no change from production) PWA: - View the detailed breakdown and full score reports

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for spirit-design-system-storybook canceled.

Name	Link
🔨 Latest commit	ac0dcf3
🔍 Latest deploy log	https://app.netlify.com/sites/spirit-design-system-storybook/deploys/678130ae3d9e560008a7434e

[coveralls]

Changes unknown
when pulling cf6b2ac on style/text-linting
into ** on main**.

[adamkudrna]

Introduce teyxt linting of our documentation

Are we also linting commit messages and PR names? 🙂

[literat]

Introduce teyxt linting of our documentation

Are we also linting commit messages and PR names? 🙂

Maybe we should 😅 -> https://github.com/marketplace/actions/pull-request-linter-action

[adamkudrna]

I think this is way too much opinionated. At least in this form. I mean, there are some nice touches and things I'd like to see checked, but I cannot give it a ✅ as a whole.

@literat (and everyone here) I jotted down some comments but I feel the discussion needs to be more structured. Can we maybe discuss individual rules first? What do you think is the best approach? (Long topics?)

[literat]

@adamkudrna Thanks for the review. Let's tweak it to our desires and needs. I think that the most problematic rule will be the stop-words.

Sources of stop words: https://github.com/sapegin/textlint-rule-stop-words?tab=readme-ov-file#sources

CAn be disabled, rewritten or excluded: https://github.com/sapegin/textlint-rule-stop-words?tab=readme-ov-file#defaultwords-default-true

The simple approach now can be just to disable apostrophe and stop-words and move on and in the meantime, discuss the possibilities and options.

[literat]

Just for the note: the apostrophe rule cannot be modified, so we can end up with a mixture of apostrophes. But I think the preference is '.