reusable-workflows icon indicating copy to clipboard operation
reusable-workflows copied to clipboard

Add linting for the documentation and fix any current issues

Open meszarosrob opened this issue 1 year ago • 1 comments

Please check if the PR fulfills these requirements

  • [x] The commit message follows our guidelines
  • [ ] Tests for the changes have been added (for bug fixes/features)
  • [x] Docs have been added/updated (for bug fixes/features)

What kind of change does this PR introduce? (Bug fix, feature, docs update, ...) Feature, docs update.

What is the current behavior? (You can also link to an open issue here) There's no linting set up for the documentation, which has resulted in some inconsistencies.

What is the new behavior (if this is a feature change)? Markdown files are linted when updated or newly added, and the current documentation passes the linting.

Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?) No.

Other information: None.

meszarosrob avatar Aug 13 '24 12:08 meszarosrob

@tyrann0us

Also, why does Markdownlint complain about italics?

The error was about consistency, rather than about italics per se. The text remained italicized after the fix https://github.com/inpsyde/reusable-workflows/pull/149/commits/9394ed35034cc206f99a423af875224f6e5d9265.

meszarosrob avatar Aug 13 '24 16:08 meszarosrob