feat(ja): update outdated Japanese docs#3960
Merged
Conversation
Update outdated Japanese translations in src/content/docs/ja/ to match the latest English documentation: - assist/index.mdx: Add IDE usage section and enforce assist configuration - linter/index.mdx: Major update with configuration, domains, editor integration, and FAQ sections - index.mdx: Add Biome v2.4 banner and update feature cards - internals/language-support.mdx: Add plugin support column and update HTML super languages section - formatter/index.mdx: Rewrite CLI section and restructure options - guides/configure-biome.mdx: Enhance configuration file resolution and exclude files sections - reference/configuration.mdx: Add root, assist, and html sections with comprehensive updates All changes pass textlint validation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 WalkthroughThis PR makes broad documentation updates across the website: small copy fixes (e.g. "VSCode" → "VS Code"), internalises an HTML explicit opt‑in link, bumps TypeScript support from 5.6 to 5.9, and adds large rewrites to Japanese docs (assist, formatter, linter, configuration, language‑support). It introduces assist/formatter configuration and CLI/editor guidance, documents scanner/includes behaviour and new config keys in the reference, and marks several HTML/embedding features as experimental with opt‑in examples. Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 10
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/content/docs/ja/reference/configuration.mdx (1)
1491-1521:⚠️ Potential issue | 🟠 MajorFix
overrides.<ITEM>.includefield name—documentation uses incorrect plural form.
The schema defines the field asinclude(singular), notincludes. Update the section title fromoverrides.<ITEM>.includestooverrides.<ITEM>.include, and fix the first code example accordingly to match the second one.
🤖 Fix all issues with AI agents
In `@src/content/docs/internals/language-support.mdx`:
- Around line 21-23: Update the TypeScript version claim in the documentation:
replace the incorrect "TypeScript 5.9" text with the correct "TypeScript 5.6"
wherever the file references the supported TypeScript version (the mention near
the language-support table and specifically the TypeScript version string). Keep
the experimental status for Vue, Svelte, and Astro as-is and leave the HTML
opt-in note unchanged.
In `@src/content/docs/ja/assist/index.mdx`:
- Line 41: Fix the small typo in the sentence referencing the code action:
change "こののコード" to "このコード" in the paragraph that mentions the action
[`useSortedKeys`] and the action identifier `source.action.useSortedKeys.biome`,
and the suggested placement under `editor.codeActionsOnSave`.
In `@src/content/docs/ja/guides/configure-biome.mdx`:
- Line 211: Update the inconsistent link by replacing the non-localised path
"/linter/domains/#project" with the Japanese-localised path
"/ja/linter/domains/#project" in the document; locate the literal string
"/linter/domains/#project" in src/content/docs/ja/guides/configure-biome.mdx and
change it to "/ja/linter/domains/#project" to match other links like those
already using the /ja/ prefix.
In `@src/content/docs/ja/index.mdx`:
- Line 106: Update the two linter links in the Japanese docs line so they are
localized: replace the href '/linter/rules-sources/' with
'/ja/linter/rules-sources/' and replace '/linter/' with '/ja/linter/' in the
string containing "**[<NumberOfRules/>個のルール](/linter/)**" (search for those
exact URL substrings in src/content/docs/ja/index.mdx and update them
accordingly).
- Around line 158-160: The enterprise link in the Card component currently
points to "/enterprise/" and must be localized; change the href in the Card (the
<Card title="エンタープライズサポート" icon="phone"> link) to "/ja/enterprise/" if a
Japanese page exists, otherwise make the intent explicit by either linking to
the English page with an explicit note (e.g., add text indicating the link goes
to the English site) or add a language query/target to indicate it opens the
English content.
In `@src/content/docs/ja/linter/index.mdx`:
- Line 38: Update the English doc links in src/content/docs/ja/linter/index.mdx
to point to the Japanese-localised paths by prefixing "/ja/" for each affected
link: replace "/reference/cli#biome-lint" with "/ja/reference/cli#biome-lint",
"/linter/rules/no-debugger" with "/ja/linter/rules/no-debugger",
"/linter/domains" with "/ja/linter/domains", and "/linter/rules-sources" with
"/ja/linter/rules-sources" so all internal links in this Japanese page reference
the localized routes.
- Around line 422-426: The documentation contains non-localized links: replace
all occurrences of "/linter/domains/#project" and
"/linter/domains#project-rules" in the text with their Japanese-localized
counterparts "/ja/linter/domains/#project" and
"/ja/linter/domains#project-rules" (these appear in the strings in the
paragraphs mentioning scanners and project-domain rules) so internal links point
to the Japanese docs; update every instance (including the ones noted around the
scanner FAQ) to ensure consistency.
- Around line 193-194: The anchor links `#safe-fixes` and `#unsafe-fixes` do not
match the actual section headers; update the two links so they point to the
anchors generated from the full headers "安全な修正 (Safe fixes)" and "安全でない修正
(Unsafe fixes)". Replace `#safe-fixes` with the anchor that matches the header
"安全な修正 (Safe fixes)" and replace `#unsafe-fixes` with the anchor that matches
"安全でない修正 (Unsafe fixes)" (use the exact slug your markdown processor generates
from those header texts so the links resolve correctly).
In `@src/content/docs/ja/reference/configuration.mdx`:
- Around line 225-228: The documentation has an extension mismatch: the glob
patterns and text mention `.test.js` but the example filename is
`special.test.ts` (also repeats in other sections referenced as 364-367 and
468-471). Fix by making the extensions consistent—either change the example
filename `special.test.ts` to `special.test.js` wherever it appears, or broaden
the pattern text to mention both `.test.js` and `.test.ts` (or `.test.(js|ts)`)
so the docs match the glob; update all occurrences of the mismatched strings
(`.test.js`, `special.test.ts`) accordingly to keep the three bullet examples
consistent.
- Around line 435-450: The in-page link uses the English anchor
'#glob-syntax-reference' but the heading is Japanese "Glob構文リファレンス", breaking
the link; fix by adding an explicit HTML anchor id="glob-syntax-reference"
immediately before the "Glob構文リファレンス" heading (or alternatively change the link
to '#glob構文リファレンス') so the reference in the "formatter.includes" section
resolves correctly; look for the heading text "Glob構文リファレンス" and the link
"#glob-syntax-reference" to make the change.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@src/content/docs/ja/linter/index.mdx`:
- Line 12: Update the internal link in the Japanese doc line that currently
points to '/internals/language-support' so it uses the Japanese page path
'/ja/internals/language-support'; edit the string within the sentence containing
"[複数の言語](/internals/language-support)" (the line with the <NumberOfRules/>
component) to replace the href to '/ja/internals/language-support' so readers
stay on the Japanese site.
siketyan
force-pushed
the
feat/update-ja-docs
branch
from
2b6dea7 to
faea540
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@src/content/docs/ja/reference/configuration.mdx`:
- Around line 100-101: Update the first link in the sentence so the architecture
link is localized: change the target `/internals/architecture/#scanner` to
`/ja/internals/architecture/#scanner`, while leaving the domains link
`/linter/domains/#project` unchanged (keep it in English) so only the
architecture link is localized.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/ja/internals/language-support.mdx`:
- Around line 12-13: Translate the English table headers into Japanese for
consistency on the page by replacing the header strings "Language", "Parsing",
"Formatting", "Linting", and "Plugin Support" in the table header row with their
appropriate Japanese equivalents (e.g., 言語, パース, フォーマット, リンティング, プラグインサポート)
while keeping the Markdown table pipe/column alignment intact and leaving the
rest of the table content unchanged.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/content/docs/ja/internals/language-support.mdx (1)
136-136: Playground link uses English URL.For consistency with the Japanese documentation, consider whether there's a Japanese playground path (e.g.,
/ja/playground). If not available, this is fine as-is.✍️ Possible change (if Japanese path exists)
-この最後のセクションは古くなる可能性があるため、[プレイグラウンド](https://biomejs.dev/playground)を使用して、機能が実装されているかどうかを確認することをお勧めします。 +この最後のセクションは古くなる可能性があるため、[プレイグラウンド](/ja/playground)を使用して、機能が実装されているかどうかを確認することをお勧めします。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/ja/internals/language-support.mdx` at line 136, In the Japanese doc file language-support.mdx the playground link currently points to "https://biomejs.dev/playground"; verify whether a Japanese playground route exists and if so update that URL to "https://biomejs.dev/ja/playground" to match the document language (otherwise leave as-is); locate the playground URL string in src/content/docs/ja/internals/language-support.mdx and replace the path accordingly while keeping the surrounding text unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/ja/internals/language-support.mdx`:
- Line 31: The footnote in the line containing "*\*
現在、[明示的なオプトイン](https://biomejs.dev/reference/configuration/#html)が必要です。*" links
to the English docs; update that link to the Japanese documentation (use
"/ja/reference/configuration/#html" or the appropriate Japanese URL) so it
points to the localized page and matches the rest of the Japanese docs; leave
the surrounding text unchanged and ensure the link target is consistent across
other Japanese pages.
---
Duplicate comments:
In `@src/content/docs/ja/internals/language-support.mdx`:
- Around line 12-13: The table header row currently uses English headers
("Language | Parsing | Formatting | Linting | Plugin Support"); update that
header row in src/content/docs/ja/internals/language-support.mdx so the five
column labels are translated into Japanese (e.g., "言語 | 解析 | 整形 | リント | プラグイン対応"
or other appropriate Japanese terms) so the table matches the rest of the page;
keep the pipe-separated table format and ensure alignment/column count remains
unchanged.
---
Nitpick comments:
In `@src/content/docs/ja/internals/language-support.mdx`:
- Line 136: In the Japanese doc file language-support.mdx the playground link
currently points to "https://biomejs.dev/playground"; verify whether a Japanese
playground route exists and if so update that URL to
"https://biomejs.dev/ja/playground" to match the document language (otherwise
leave as-is); locate the playground URL string in
src/content/docs/ja/internals/language-support.mdx and replace the path
accordingly while keeping the surrounding text unchanged.
a672f56 to
9947d8b
Compare
siketyan
force-pushed
the
feat/update-ja-docs
branch
from
9947d8b to
5d11cf7
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Note
AI Disclosure: I used Claude Agent to create the first draft of this PR (see 36350df). All the changes have been reviewed and revised by me.
Updated outdated information in Japanese docs.
If you are interested, here is the prompt I used (in Japanese).