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

docs: Update vale config to get vocab dependency #865

Merged
merged 1 commit into from
Aug 13, 2024

Conversation

edibotopic
Copy link
Collaborator

@edibotopic edibotopic commented Aug 13, 2024

This updates the configuration settings for the Vale linter, based on recent changes to the docs Starter Pack.

The linter now works as expected. Running checks on a specific file can be done as follows:

make vale TARGET=tutorial/getting-started.md

This prints a list of errors, suggestions and warnings relating to documentation style, such as:

162:1 warning Avoid inline comments in codeblocks Canonical.016-No-inline-comments

UDENG-3785

@edibotopic edibotopic changed the title Update vale config to get vocab dependency docs: Update vale config to get vocab dependency Aug 13, 2024
@edibotopic edibotopic marked this pull request as ready for review August 13, 2024 09:25
@edibotopic edibotopic requested a review from a team as a code owner August 13, 2024 09:25
Copy link
Contributor

@jibel jibel left a comment

Choose a reason for hiding this comment

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

okay, synced with starter pack. +1

@edibotopic edibotopic merged commit 878ebb3 into main Aug 13, 2024
4 of 5 checks passed
@edibotopic edibotopic deleted the docs-update-vale-config-get-vocab branch August 13, 2024 10:30
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.

2 participants