Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add linting for the documentation and fix any current issues #149

Merged
merged 17 commits into from
Aug 19, 2024

Conversation

meszarosrob
Copy link
Member

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes/features)
  • 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.

Copy link
Member

@tyrann0us tyrann0us left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for working on this! Left some inline comments and questions.
Also, why does Markdownlint complain about italics?

.github/workflows/_lint-docs.yml Show resolved Hide resolved
.github/workflows/_lint-docs.yml Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/php.md Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@meszarosrob
Copy link
Member Author

@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 9394ed3.

Co-authored-by: Philipp Bammes <[email protected]>
Signed-off-by: Mészáros Róbert <[email protected]>
@meszarosrob meszarosrob requested a review from tyrann0us August 13, 2024 16:36
Copy link
Member

@tyrann0us tyrann0us left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for implementing the changes. LGTM. 👌🏽

The error was about consistency, rather than about italics per se. The text remained italicized after the fix 9394ed3.

Ah, sure. A single asterisk is italic; a double asterisk is bold … 🤦🏽‍♂️ Sorry for the noise!

docs/php.md Outdated Show resolved Hide resolved
Co-authored-by: Philipp Bammes <[email protected]>
Signed-off-by: Mészáros Róbert <[email protected]>
@tyrann0us tyrann0us merged commit 530b2ee into main Aug 19, 2024
2 checks passed
@tyrann0us tyrann0us deleted the chore/fix-lint-md-docs-errors branch August 19, 2024 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants