Skip to content

Conversation

3w36zj6
Copy link
Member

@3w36zj6 3w36zj6 commented Apr 3, 2025

Changes

  • Created a docs/ directory to manage documentation
  • Initialized package.json in the docs/ directory with textlint and rules for English writing
  • Added symlinks in docs/ pointing to /README.md and /packages/textlint/README.md
  • Implemented a GitHub Actions workflow to automatically run textlint checks

Notes

  • We couldn't install textlint in the root devDependencies because its package name conflicts with this VS Code extension project's name. This is why we created a separate docs directory with symlinks.
  • The textlint rules we've adopted are based on those used in the textlint/textlint repository.

@3w36zj6 3w36zj6 marked this pull request as draft April 3, 2025 13:06
@3w36zj6 3w36zj6 force-pushed the feature/add-textlint-linting branch from baa002a to 8b4a6bd Compare April 3, 2025 15:22
@3w36zj6 3w36zj6 requested a review from Copilot April 3, 2025 15:50
@3w36zj6 3w36zj6 marked this pull request as ready for review April 3, 2025 15:51
Copy link
Contributor

@Copilot Copilot AI left a 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

@3w36zj6 3w36zj6 requested a review from azu April 3, 2025 15:58
Copy link
Member

@azu azu left a comment

Choose a reason for hiding this comment

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

LGTM

Comment on lines +7 to +9
- expected: VS Code
pattern: /\bvs ?code\b(?!-)/i
prh: VS Code is the official spelling.
Copy link
Member

Choose a reason for hiding this comment

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

I never knew 👀

@azu azu added documentation Type: CI Changes to CI configuration files and scripts labels Apr 3, 2025
@3w36zj6 3w36zj6 merged commit 0ec2f94 into main Apr 4, 2025
5 checks passed
@3w36zj6 3w36zj6 deleted the feature/add-textlint-linting branch April 4, 2025 06:22
@3w36zj6 3w36zj6 added Type: Documentation Documentation only changes and removed documentation labels Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: CI Changes to CI configuration files and scripts Type: Documentation Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants