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 2 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
├── 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 5fd62c5
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/686bd389b9ea170008536e57
😎 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
@sarah11918
Copy link
Member

Hi @jp-knj - I'm noticing that there are conflicts here that will need to be resolved.

Also, the open discussion seems to be ongoing, so I'm not sure what the status of this is, and what we need to go further with this. How will we know that we want this? Maybe the first step is at least to resolve the conflicts here?

@sarah11918 sarah11918 added the consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. label Jul 7, 2025
@jp-knj jp-knj force-pushed the add-textlint-config branch 5 times, most recently from e3c353d to fd4bfa7 Compare July 7, 2025 13:58
@jp-knj jp-knj force-pushed the add-textlint-config branch from 05c53a8 to 5fd62c5 Compare July 7, 2025 14:02
@jp-knj
Copy link
Contributor Author

jp-knj commented Jul 7, 2025

Thank you for noticing the conflicts.
I’ve pushed a commit that should resolve them, but Not completely sure everything is in order.

When you have a moment, could you take a quick look and let me know if there’s anything else we need before merging?

I really appreciate your time, and I’m happy to make any updates. Thanks again!

@sarah11918
Copy link
Member

Thanks @jp-knj ! Admittedly, I haven't been keeping up too much with the conversation in the Discussion #11665 as it seems Chris had some questions/comments. I think the next step is checking in with him there to make sure all his concerns are addressed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants