chore: add textlint linting for documentation (#14)

Author: 3w36zj6

.github/workflows/docs.yaml

@@ -0,0 +1,38 @@
+name: Lint documentation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  setup:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: jdx/mise-action@5083fe46898c414b2475087cc79da59e7da859e8 # v2.1.11
+      - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        id: cache-node-modules
+        with:
+          path: docs/node_modules
+          key: ${{ runner.os }}-docs-${{ hashFiles('docs/package-lock.json') }}
+      - working-directory: docs/
+        run: npm ci
+
+  textlint:
+    needs: setup
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      - uses: jdx/mise-action@5083fe46898c414b2475087cc79da59e7da859e8 # v2.1.11
+      - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
+        id: cache-node-modules
+        with:
+          path: docs/node_modules
+          key: ${{ runner.os }}-docs-${{ hashFiles('docs/package-lock.json') }}
+      - working-directory: docs/
+        run: npm run textlint

README.md

@@ -2,7 +2,7 @@
 
 ![integration-tests](https://github.com/textlint/vscode-textlint/actions/workflows/integration-tests.yaml/badge.svg)
 
-Extension to integrate [textlint](https://textlint.github.io/) into VSCode.
+Extension to integrate [textlint](https://textlint.github.io/) into VS Code.
 
 ## How to install
 

docs/.gitignore

@@ -0,0 +1 @@
+node_modules/

docs/.textlintrc.json

@@ -0,0 +1,18 @@
+{
+  "plugins": {},
+  "filters": {
+    "comments": true
+  },
+  "rules": {
+    "prh": {
+      "rulePaths": ["./prh.yaml"]
+    },
+    "rousseau": {
+      "showLevels": ["warning", "error"],
+      "ignoreTypes": ["sentence:uppercase", "passive", "weasel", "readibility"]
+    },
+    "unexpanded-acronym": {
+      "ignore_acronyms": ["SCG", "CLI", "XML", "YAML", "JSON", "TODO", "API", "HTML", "MIT", "FAQ", "VIEW"]
+    }
+  }
+}

docs/README_EXTENSION.md

@@ -0,0 +1 @@
+../packages/textlint/README.md

docs/README_ROOT.md

@@ -0,0 +1 @@
+../README.md