Skip to content

Add textlint to enforce writing guide #11812

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jp-knj
Copy link
Contributor

@jp-knj jp-knj commented May 31, 2025

Description (required)

This PR adds and configures textlint to enforce the Astro Japanese writing guide for our documentation. It introduces a new prh.yml file with terminology rules (e.g., 標準表記の統一やコロン「:」の検出) and updates the .textlintrc.ja.json configuration to load those rules. contributors will receive automated feedback on terminology usage and formatting consistency in Japanese docs, reducing manual proofreading errors and ensuring a unified style.

📁 Directory Structure

.
├── .textlintrc.ja.json                ← (new) Textlint config for Japanese rules
├── prh.yml                            ← (new) proofreading dictionary (日本語用ルール)
├── package.json                       ← (modified) adds `lint:ja` script, textlint dependencies
└── src
    └── content
        └── docs
            └── ja
                └── …                  ← (existing) Japanese‐language MDX/MD files

Related issues & labels (optional)

Copy link

netlify bot commented May 31, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3207f60
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/683ac19eb01da20008240d60
😎 Deploy Preview https://deploy-preview-11812--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jp-knj jp-knj marked this pull request as ready for review May 31, 2025 08:53
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.

1 participant