-
-
Notifications
You must be signed in to change notification settings - Fork 2
chore: add textlint linting for documentation #14
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
Conversation
baa002a
to
8b4a6bd
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR establishes textlint linting for the documentation by creating a dedicated docs directory and configuring necessary linting files and workflows.
- Adds a new docs directory with its own package.json and textlint configuration.
- Creates symlinks to key README files to maintain consistency.
- Implements a GitHub Actions workflow to automatically run textlint checks on documentation changes.
Reviewed Changes
Copilot reviewed 7 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
packages/textlint/README.md | Updates markdown formatting for clarity. |
docs/prh.yaml | Introduces textlint spelling rules for docs text. |
docs/README_ROOT.md | Adds a symlink to the project root README. |
docs/README_EXTENSION.md | Adds a symlink to the textlint extension README. |
.github/workflows/docs.yaml | New workflow for automated documentation linting. |
Files not reviewed (3)
- docs/.gitignore: Language not supported
- docs/.textlintrc.json: Language not supported
- docs/package.json: Language not supported
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
- expected: VS Code | ||
pattern: /\bvs ?code\b(?!-)/i | ||
prh: VS Code is the official spelling. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I never knew 👀
Changes
docs/
directory to manage documentationpackage.json
in thedocs/
directory with textlint and rules for English writingdocs/
pointing to/README.md
and/packages/textlint/README.md
Notes
devDependencies
because its package name conflicts with this VS Code extension project'sname
. This is why we created a separate docs directory with symlinks.