feat: documentation linting #1745
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarahdayan
added
topic: docs
Closed
|
@sarahdayan how about Chinese and Russian languages? Are they supported? |
|
Hey @sarahdayan, thank you for your time and effort spent on this PR, contributions like yours help make Vue better for everyone. Cheers! 💚 |
Unfortunately they're not. There are some rules for Japanese out there, but if we want to support Chinese and Russian we'll have to create new rules. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds content linting to the documentation of VuePress, using textlint.
Some rules (the more subjective ones) are set with a warning severity, meaning they wouldn't make a CI fail. It also leaves the possibility of progressively fixing things.
The PR is quite large because it also embarks a first run at fixing issues that were revealed by textlint.
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
Other information:
Content linting was added as a pre-commit hook. I changed the way the other pre-commit hook was wired so the whole thing works properly across the monorepo.
❓Question: for now, the linting precommit hooks are split into two:
docs/(the one created in this PR)They're triggered by running the global precommit first, then the local ones with
lerna run.Ideally, it's better to have a command per repo. Do we think it's worth it?