Introduce text linting of our documentation #1588

literat · 2024-08-22T15:49:21Z

Description

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

Additional context

Issue reference

netlify · 2024-08-22T15:49:36Z

✅ Deploy Preview for spirit-design-system ready!

Name	Link
🔨 Latest commit	`cf6b2ac`
🔍 Latest deploy log	https://app.netlify.com/sites/spirit-design-system/deploys/66ec3d017548ae000796024b
😎 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: 93 (no change from production) Best Practices: 100 (no change from production) SEO: 82 (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 · 2024-08-22T15:49:45Z

✅ Deploy Preview for spirit-design-system-storybook ready!

Name	Link
🔨 Latest commit	`cf6b2ac`
🔍 Latest deploy log	https://app.netlify.com/sites/spirit-design-system-storybook/deploys/66ec3d02f792780008cc876e
😎 Deploy Preview	https://deploy-preview-1588--spirit-design-system-storybook.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coveralls · 2024-08-22T15:53:40Z

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

adamkudrna · 2024-08-23T18:58:44Z

Introduce teyxt linting of our documentation

Are we also linting commit messages and PR names? 🙂

literat · 2024-08-26T07:23:14Z

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

…rules

… rules

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?)

adamkudrna · 2024-12-17T16:40:28Z

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Spirit Design System

-First of all, thanks for your contribution to this project! ❤️
+Thanks for your contribution to this project! ❤️


Why? I don't feel it was wrong…

adamkudrna · 2024-12-17T16:45:19Z

CONTRIBUTING.md

@@ -31,7 +31,7 @@ See [Developer Handbook][developer-handbook] for more information about developm

 ## Commit Conventions

-All commits you make SHOULD adhere to our commit guidelines. We use [conventional commits][conventional-commits] strategy with a slight modification of our own - [@lmc-eu/commitlint-config][commitlint-config]. This is later used during the release phase to determine how to bump the packages' version numbers based on commit history. 🚀
+All commits you make SHOULD adhere to our commit guidelines. We use [conventional commits][conventional-commits] strategy with a slight modification of our own - [@lmc-eu/commitlint-config][commitlint-config]. This is later used during the release phase to determine how to bump the packages’ version numbers based on commit history. 🚀


The correct apostrophe sign is important for a great typography, and I have always been rooting for a great typography.

But this is a technical document and I'm afraid people (I mean us) will struggle with the correct styling. If we are going to check the correct apostrophe character, I'd also check quotes and dashes, to name a few. But we cannot force people to use them, IMO.

adamkudrna · 2024-12-17T16:45:54Z

CONTRIBUTING.md

@@ -74,7 +74,7 @@ The `<type>` and `<summary>` fields are mandatory, the `(<scope>)` field is opti

 MUST be one of the following:

- **Chore**: Changes to our CI configuration files and scripts (examples: CircleCI, SauceLabs) or changes that affect the build system
+- **Chore**: Changes to our CI configuration files and scripts (examples: CircleCI, SauceLabs) or changes that affect the build tool


Again, I don't think "system" is a wrong word in this context.

adamkudrna · 2024-12-17T16:46:53Z

CONTRIBUTING.md

@@ -124,7 +124,7 @@ Use the summary field to provide a succinct description of the change:
 Just as in the summary, use the imperative, present tense: "fix" not "fixed" nor "fixes".

 Explain the motivation for the change in the commit message body. This commit message SHOULD explain _why_ you are making the change.
-You can include a comparison of the previous behavior with the new behavior in order to illustrate the impact of the change.
+You can include a comparison of the previous behavior with the new behavior to illustrate the impact of the change.


OK, looks better now.

adamkudrna · 2024-12-17T16:47:17Z

CONTRIBUTING.md

@@ -149,7 +149,7 @@ If the commit reverts a previous commit, it SHOULD begin with `Revert: `, follow
 The content of the commit message body SHOULD contain:

 - information about the SHA of the commit being reverted in the following format: `This reverts commit <SHA>`,
- a clear description of the reason for reverting the commit message.
+- a clear description of why the commit message is being reverted.


This is a good catch.

adamkudrna · 2024-12-17T16:48:01Z

CONTRIBUTING.md

@@ -109,7 +109,7 @@ The following is the list of supported scopes:
 - Repository-wide:
  - `ci`: used for changes that affect the Continuous Integration process and builds
  - `repo`: used for repository-wide changes
-  - none/empty string: useful for `Test` and `Refactor` changes that are done across all packages (e.g. `Test: Add missing unit tests`) and for docs changes that are not related to a specific package (e.g. `Docs: Fix typo in the tutorial`).
+  - none/empty string: useful for `Test` and `Refactor` changes that are done across all packages (for example `Test: Add missing unit tests`) and for docs changes that are not related to a specific package (for example `Docs: Fix typo in the tutorial`).


OK, I'm willing to get used to this form.

I suppose it means "i.e." is also undesired.

adamkudrna · 2024-12-17T16:48:33Z

CONTRIBUTING.md

 - checking format using the [Prettier][prettier]
- checking types using the [Typescript][typescript] compiler
+- checking types using the [TypeScript][typescript] compiler


OK, this is correct.

adamkudrna · 2024-12-17T16:49:05Z

CONTRIBUTING.md


 ### Developing and Testing GitHub Actions

 It can be time-consuming and painful to test GitHub Actions.
 First, you have to change the GitHub Actions file locally, push your local code into the GitHub repository, and wait for the result.

-To solve this issue, you can use [act][act] CLI tool to test and write the GitHub actions locally.
+To solve this issue, you can use [act][act] command line tool to test and write the GitHub actions locally.


OK 🤷🏻‍♂️

adamkudrna · 2024-12-17T16:49:33Z

DEPRECATIONS-v2.md


 ---

-Please refer back to this list or reach out to our team if you encounter any issues during migration.
+If you face any problems during migration, please check this list or contact our team for assistance.


Good, more comprehensible now.

adamkudrna · 2024-12-17T16:51:10Z

CONTRIBUTING.md

@@ -182,15 +182,15 @@ Using this you can test the entire package and verify that all parts of the pack

 The testing script includes:

- linting using [ESlint][eslint]
+- linting using [ESLint][eslint]


This is correct, but "SASS" (meaning the CSS preprocessor) is incorrect: "Sass" is correct. And there are more.

github-actions bot assigned literat Aug 22, 2024

literat changed the title ~~Introduce teyxt linting of our documentation~~ Introduce text linting of our documentation Aug 26, 2024

literat force-pushed the style/text-linting branch from e3ce182 to 91718a8 Compare September 12, 2024 06:31

literat marked this pull request as ready for review September 12, 2024 09:11

literat requested review from adamkudrna, crishpeen, pavelklibani, a team and curdaj as code owners September 12, 2024 09:11

literat force-pushed the style/text-linting branch 3 times, most recently from 406df67 to 4b9d601 Compare September 12, 2024 14:34

literat added 5 commits September 19, 2024 17:00

Style(repo): Introduce text content linting

c65419e

Style(web): Fix documentation content according to the textlint rules

fc267b8

Style(web-twig): Fix documentation content according to the textlint …

c5e8e7e

…rules

Style(web-react): Fix documentation content according to the textlint…

67bbac9

… rules

Style(repo): Fix documentation content according to the textlint rules

cf6b2ac

literat force-pushed the style/text-linting branch from 4b9d601 to cf6b2ac Compare September 19, 2024 15:02

adamkudrna requested changes Dec 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce text linting of our documentation #1588

Introduce text linting of our documentation #1588

literat commented Aug 22, 2024 •

edited

Loading

netlify bot commented Aug 22, 2024 •

edited

Loading

netlify bot commented Aug 22, 2024 •

edited

Loading

coveralls commented Aug 22, 2024 •

edited

Loading

adamkudrna commented Aug 23, 2024

literat commented Aug 26, 2024

adamkudrna left a comment

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

adamkudrna Dec 17, 2024

Introduce text linting of our documentation #1588

Are you sure you want to change the base?

Introduce text linting of our documentation #1588

Conversation

literat commented Aug 22, 2024 • edited Loading

Description

Additional context

Issue reference

netlify bot commented Aug 22, 2024 • edited Loading

✅ Deploy Preview for spirit-design-system ready!

netlify bot commented Aug 22, 2024 • edited Loading

✅ Deploy Preview for spirit-design-system-storybook ready!

coveralls commented Aug 22, 2024 • edited Loading

adamkudrna commented Aug 23, 2024

literat commented Aug 26, 2024

adamkudrna left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

literat commented Aug 22, 2024 •

edited

Loading

netlify bot commented Aug 22, 2024 •

edited

Loading

netlify bot commented Aug 22, 2024 •

edited

Loading

coveralls commented Aug 22, 2024 •

edited

Loading