Skip to content

docs: refresh public docs before launch#70

Merged
wasabeef merged 7 commits into
mainfrom
docs/publish-doc-refresh
May 10, 2026
Merged

docs: refresh public docs before launch#70
wasabeef merged 7 commits into
mainfrom
docs/publish-doc-refresh

Conversation

@wasabeef
Copy link
Copy Markdown
Owner

@wasabeef wasabeef commented May 10, 2026

Pull Request

Summary

  • Refresh README PR Report examples so the Dashboard link matches the current generated markup, including the PR-specific query string and safe new-tab attributes.
  • Reword public website entry and troubleshooting copy across all locales to avoid internal attribution jargon and explain Line Estimate in user-facing terms.
  • Keep maintainer-only architecture and knowledge docs unchanged where technical terminology is intentional.

Type of Change

  • Fix
  • Feature
  • Documentation
  • Refactor
  • Test
  • CI / release

Checklist

  • I kept structural changes separate from behavior changes where practical.
  • I added or updated tests for behavior changes.
  • I updated README / docs / website content when user-facing behavior changed.
  • I rebuilt generated bundles when bundled source changed.
  • I ran the relevant checks locally.

Notes for Reviewers

Checks run locally:

  • git diff --check
  • npm run build --prefix website

No runtime behavior changes.

🧑💬🤖 Agent Note

Total AI Ratio:
Agent Note data: No tracked commits

Commit AI Ratio Prompts Files
01e1918 docs: refresh public docs before launch
16e6dbd docs: address public docs review feedback
4da3125 docs: highlight reviewer context in README
724e4b7 docs: sharpen product value messaging
dc41efa docs: address reviewer localization feedback
da44079 docs: improve locale parity for review guidance
c9fb234 docs: polish remaining localized review copy

Summary by CodeRabbit

  • Documentation
    • PR Report examples now link to PR-specific dashboard URLs and preserve safe new-tab attributes.
    • Terminology standardized to “AI Ratio” across READMEs and docs.
    • Notes added about hidden Reviewer Context in PR bodies for AI review tools and Dashboard/agent-note why navigation.
    • Feature copy clarified: track AI-assisted commits/files and show line-estimates when evidence suffices.
    • Troubleshooting expanded with per-tool guidance for missing “Line Estimate”; CLI text updated to show recent commits with AI Ratio.
    • Clarified that ignored/generated artifacts remain visible but are excluded from the AI Ratio denominator.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 10, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 2b9d0a83-bf97-4c25-89d1-183eb7a40f07

📥 Commits

Reviewing files that changed from the base of the PR and between da44079 and c9fb234.

📒 Files selected for processing (3)
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-tw/index.mdx

📝 Walkthrough

Walkthrough

This PR updates localized README and website docs to standardize the metric label to “AI Ratio”, reframe feature copy toward AI-assisted work with conditional Line Estimate behavior, add PR-specific ?pr=123 dashboard links in PR Report examples, and revise troubleshooting to focus on Line Estimate availability.

Changes

Documentation Content Updates

Layer / File(s) Summary
Frontmatter & Feature Cards
website/src/content/docs/*/index.mdx
Frontmatter and first feature card updated to track AI-assisted work (commit/file visibility) and to describe conditional AI-written line estimates when evidence exists.
README PR Report Examples
README*.md (multiple languages)
All README examples update the “Open Dashboard” link to include ?pr=123, unify AI metric wording to “AI Ratio”, and add/adjust bullets about hidden Reviewer Context and AI conversation visibility where present.
Troubleshooting Guides
website/src/content/docs/*/troubleshooting.mdx
Troubleshooting tables and sections replace “line-level attribution” guidance with “Line Estimate is missing” and enumerate per-agent expectations and safe fallback behavior.
Agent Support / How-it-Works / Data
`website/src/content/docs/*/(agent-support
how-it-works
Commands & GitHub Action Outputs
`website/src/content/docs/*/(commands
github-action).mdx`

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • wasabeef/AgentNote#67: Related to agent-note why <file:line> navigation and dashboard linking referenced in docs.
  • wasabeef/AgentNote#63: Related to AI Ratio handling and .agentnoteignore behavior implemented elsewhere.
  • wasabeef/AgentNote#66: Overlapping documentation edits for AI Ratio and PR Report/dashboard examples.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/publish-doc-refresh

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 10

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@website/src/content/docs/de/troubleshooting.mdx`:
- Around line 94-96: The "## Line Estimate fehlt" troubleshooting paragraph is
missing the explicit safe-fallback sentence from the core guide; update that
section (under the "## Line Estimate fehlt" heading) to add a concise
user-facing fallback line that instructs the UI to avoid guessing and instead
present a safe fallback (e.g., indicate no reliable estimate and fall back to
full-file / ask user) and mirror the exact phrasing used in the base
troubleshooting guidance so locales remain parity-consistent.

In `@website/src/content/docs/fr/troubleshooting.mdx`:
- Around line 94-96: Update the French "## Line Estimate absent" section to
include the explicit fallback rule (mirror the English locale): state that when
evidence is incomplete the system falls back to a conservative/default estimate
rather than guessing, and add a sentence that "Agent Note" (Agent Note) reverts
to a safe assessment in these cases; edit the paragraph under "## Line Estimate
absent" and ensure the term "Agent Note" appears clearly with the fallback
behavior described to preserve locale parity and user-facing troubleshooting
details.

In `@website/src/content/docs/id/troubleshooting.mdx`:
- Around line 94-96: Update the "## Line Estimate tidak muncul" section to
include a clear Indonesian-language fallback clarification stating that when
evidence is incomplete Agent Note falls back safely rather than guessing; edit
the paragraph that describes CLI/tool behaviors (the "Line Estimate tidak
muncul" block) to add one or two concise sentences mentioning "Agent Note" by
name and explaining the safe fallback behavior, ensuring the wording matches the
locale and tone of nearby entries to maintain locale parity and clear
user-facing guidance.

In `@website/src/content/docs/ja/index.mdx`:
- Around line 36-37: Replace the English nouns "Commit / file" inside the Card
(title "AI が関わった変更を残す") with Japanese-equivalent nouns for locale
consistency—e.g., change "Commit / file" to "コミット/ファイル" or "コミットやファイル" in the
Card body text so the sentence reads naturally in Japanese.

In `@website/src/content/docs/ko/index.mdx`:
- Around line 36-37: 문장이 영어명사 혼용과 띄어쓰기 때문에 자연스럽지 않으니 Card 컴포넌트(타이틀 "AI가 도운 변경을
기록으로 남기기") 내부의 본문 텍스트를 자연스러운 한국어 표현으로 바꿔주세요; 예를 들어 "어떤 커밋과 파일에 AI의 도움이 있었는지
확인하고, 근거가 충분하면 AI가 작성한 줄의 추정치도 표시합니다."처럼 영어 단어를 한국어로 바꾸고 조사/띄어쓰기를 정리해 문맥 흐름을
매끄럽게 만드세요.

In `@website/src/content/docs/ru/index.mdx`:
- Line 37: The sentence "Видно, какие commits и files были изменены с помощью
ИИ. Когда доказательств достаточно, Agent Note также оценивает строки,
написанные ИИ." mixes English git terms into Russian; update that sentence by
replacing "commits" with "коммиты" and "files" with "файлы" so it reads
naturally in Russian (leave product terms like "Agent Note" unchanged); locate
the sentence containing "commits и files" and perform the two-word
substitutions.

In `@website/src/content/docs/zh-cn/index.mdx`:
- Around line 36-37: The wording mixes English nouns in the Chinese copy inside
the Card component; update the Card body text (the string under Card title "记录
AI 参与的变更") to use localized zh-CN nouns—e.g., replace "Commit" with "提交" and
"file" with "文件" (and optionally "Agent Note" with a localized term) so the
sentence reads naturally in Chinese while preserving the meaning about which
commits and files had AI help and that Agent Note may estimate lines authored by
AI.

In `@website/src/content/docs/zh-cn/troubleshooting.mdx`:
- Around line 94-96: Update the "## Line Estimate 没有显示" locale block to
explicitly state the non-guessing fallback rule: when Claude Code / Codex CLI /
Cursor / Gemini CLI cannot produce a reliable line estimate, the UI/logging
should show a clear "no estimate" or "estimate unavailable" fallback instead of
guessing; mention the specific behaviors already described (Claude Code, Codex
CLI, Cursor, Gemini CLI) and add one sentence telling users what message they
will see and why (e.g., "Line Estimate: unavailable — insufficient edit
evidence"), so the Chinese troubleshooting text mirrors the English locale and
preserves parity.

In `@website/src/content/docs/zh-tw/index.mdx`:
- Around line 36-37: The copy inside the Card component (title "記錄 AI 參與的變更")
mixes English nouns "Commit" and "file" into zh-TW text; update the inner
sentence to use localized zh-TW terms (e.g., "提交紀錄" or "提交" for Commit and "檔案"
for file) so it reads naturally—modify the Card's content string accordingly and
keep the rest of the sentence structure intact (the Card component and its title
remain unchanged).

In `@website/src/content/docs/zh-tw/troubleshooting.mdx`:
- Line 96: Replace the English phrase "AI share" with the localized term "AI 比例"
in the sentence about Gemini CLI to match the rest of the zh-tw wording; ensure
the phrase in the line that currently reads "Gemini CLI 目前只顯示檔案級 AI share。"
becomes "Gemini CLI 目前只顯示檔案級 AI 比例。", keeping surrounding punctuation and
grammar intact so terminology is consistent across the document.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 83ce97fc-4337-4fcd-833d-d7eb824fb1ed

📥 Commits

Reviewing files that changed from the base of the PR and between 56c64ed and 01e1918.

📒 Files selected for processing (36)
  • README.de.md
  • README.es.md
  • README.fr.md
  • README.id.md
  • README.it.md
  • README.ja.md
  • README.ko.md
  • README.md
  • README.pt-br.md
  • README.ru.md
  • README.zh-cn.md
  • README.zh-tw.md
  • website/src/content/docs/de/index.mdx
  • website/src/content/docs/de/troubleshooting.mdx
  • website/src/content/docs/es/index.mdx
  • website/src/content/docs/es/troubleshooting.mdx
  • website/src/content/docs/fr/index.mdx
  • website/src/content/docs/fr/troubleshooting.mdx
  • website/src/content/docs/id/index.mdx
  • website/src/content/docs/id/troubleshooting.mdx
  • website/src/content/docs/index.mdx
  • website/src/content/docs/it/index.mdx
  • website/src/content/docs/it/troubleshooting.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ja/troubleshooting.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/ko/troubleshooting.mdx
  • website/src/content/docs/pt-br/index.mdx
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/ru/index.mdx
  • website/src/content/docs/ru/troubleshooting.mdx
  • website/src/content/docs/troubleshooting.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-cn/troubleshooting.mdx
  • website/src/content/docs/zh-tw/index.mdx
  • website/src/content/docs/zh-tw/troubleshooting.mdx

Comment thread website/src/content/docs/de/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/fr/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/id/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/ja/index.mdx Outdated
Comment thread website/src/content/docs/ko/index.mdx Outdated
Comment thread website/src/content/docs/ru/index.mdx Outdated
Comment thread website/src/content/docs/zh-cn/index.mdx Outdated
Comment thread website/src/content/docs/zh-cn/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/zh-tw/index.mdx Outdated
Comment thread website/src/content/docs/zh-tw/troubleshooting.mdx Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@website/src/content/docs/it/troubleshooting.mdx`:
- Line 96: Replace the localized phrase "quota IA" with the project canonical
term "AI Ratio" wherever it appears in the Italian troubleshooting doc
(specifically the sentence that currently reads "Gemini CLI al momento mostra
solo la quota IA a livello file"); update that sentence to use "AI Ratio"
verbatim to ensure consistency with the rest of the project's UI/docs and across
locales.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 634f1152-f383-40bd-b9c2-ada20f63a09b

📥 Commits

Reviewing files that changed from the base of the PR and between 01e1918 and 16e6dbd.

📒 Files selected for processing (18)
  • website/src/content/docs/de/troubleshooting.mdx
  • website/src/content/docs/es/troubleshooting.mdx
  • website/src/content/docs/fr/troubleshooting.mdx
  • website/src/content/docs/id/troubleshooting.mdx
  • website/src/content/docs/it/troubleshooting.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ja/troubleshooting.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/ko/troubleshooting.mdx
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/ru/index.mdx
  • website/src/content/docs/ru/troubleshooting.mdx
  • website/src/content/docs/zh-cn/commands.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-cn/troubleshooting.mdx
  • website/src/content/docs/zh-tw/commands.mdx
  • website/src/content/docs/zh-tw/index.mdx
  • website/src/content/docs/zh-tw/troubleshooting.mdx

Comment thread website/src/content/docs/it/troubleshooting.mdx Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.it.md`:
- Line 39: Sostituisci la frase "Fornisci agli AI Review tools contesto nascosto
nel PR body, così Copilot, CodeRabbit, Devin e Greptile possono revisionare con
l'intento dell'autore." con una costruzione più naturale in italiano, ad
esempio: "Fornisci ai tool di review basati su AI un contesto nascosto nel body
del PR, in modo che Copilot, CodeRabbit, Devin e Greptile possano revisionare
rispettando l'intento dell'autore."; aggiorna il testo nel file README.it.md
mantenendo gli stessi riferimenti ai tool e assicurando che la terminologia sia
coerente con il resto del documento.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 76b0636e-69a9-476b-a53a-624420d3d337

📥 Commits

Reviewing files that changed from the base of the PR and between 16e6dbd and 4da3125.

📒 Files selected for processing (30)
  • README.de.md
  • README.es.md
  • README.fr.md
  • README.id.md
  • README.it.md
  • README.ja.md
  • README.ko.md
  • README.md
  • README.pt-br.md
  • README.ru.md
  • README.zh-cn.md
  • README.zh-tw.md
  • website/src/content/docs/de/troubleshooting.mdx
  • website/src/content/docs/es/troubleshooting.mdx
  • website/src/content/docs/fr/troubleshooting.mdx
  • website/src/content/docs/id/troubleshooting.mdx
  • website/src/content/docs/it/troubleshooting.mdx
  • website/src/content/docs/ja/github-action.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ja/troubleshooting.mdx
  • website/src/content/docs/ko/github-action.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/ko/troubleshooting.mdx
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/ru/troubleshooting.mdx
  • website/src/content/docs/troubleshooting.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-cn/troubleshooting.mdx
  • website/src/content/docs/zh-tw/index.mdx
  • website/src/content/docs/zh-tw/troubleshooting.mdx

Comment thread README.it.md Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 9

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.pt-br.md`:
- Line 37: Update the Portuguese copy to use a consistent localized term:
replace the English word "response" in the sentence "Registre prompt, response,
arquivos alterados e AI Ratio para cada Commit assistido por AI." with the
Portuguese plural "respostas" so the line reads "Registre prompt, respostas,
arquivos alterados e AI Ratio para cada Commit assistido por AI."; locate the
occurrence by searching for the exact sentence or the token "response" in
README.pt-br.md and apply the substitution.

In `@website/src/content/docs/de/troubleshooting.mdx`:
- Around line 94-98: The paragraph under the "Line Estimate fehlt" header is
dense and packs four tool-specific conditions into one sentence; split the
sentence about Claude Code, Codex CLI, Cursor, and Gemini CLI into either a
short bulleted list or four short sentences to improve scannability, keeping the
same content and order (i.e., one item/sentence for Claude Code, one for Codex
CLI, one for Cursor, and one for Gemini CLI) and preserve the following
surrounding text about incomplete evidence and Agent Note behavior.

In `@website/src/content/docs/fr/data-and-privacy.mdx`:
- Line 26: Replace the English phrase "line counts" in the table row string `|
`attribution` | AI Ratio, méthode et line counts |` with the French translation
"nombre de lignes" so the row reads `| `attribution` | AI Ratio, méthode et
nombre de lignes |`; update the content in
website/src/content/docs/fr/data-and-privacy.mdx where that exact table row
appears.

In `@website/src/content/docs/fr/github-action.mdx`:
- Line 66: The report-content bullet uses "ratio IA" while the table row uses
the canonical product term `overall_ai_ratio` described as "AI Ratio"; update
the report-content bullet text to use the exact phrase "AI Ratio" for
consistency (search for the report-content bullet near the `overall_ai_ratio`
reference and replace "ratio IA" with "AI Ratio").

In `@website/src/content/docs/id/github-action.mdx`:
- Line 66: The report-content list still uses the localized term "rasio AI"
while the Outputs table uses `overall_ai_ratio`; update the bullet in the
report-content list to the implementation-accurate term "AI Ratio" so
terminology matches `overall_ai_ratio` (search for the bullet mentioning "rasio
AI" and replace it with "AI Ratio").

In `@website/src/content/docs/it/github-action.mdx`:
- Line 66: The report summary still uses the Italian term "rapporto IA" while
the metric row `overall_ai_ratio` was changed to the canonical "AI Ratio";
update the corresponding report bullet (the summary text referencing
`overall_ai_ratio` / the report summary bullet) from "rapporto IA" to "AI Ratio"
so terminology is consistent with the `overall_ai_ratio` table entry and other
docs.

In `@website/src/content/docs/ja/index.mdx`:
- Line 3: Update the description string in index.mdx so it no longer asserts
that line estimates are always recorded; instead make it conditional (e.g., add
"when available" or "if supported by the agent/evidence") to reflect that
prompt/response/AI-written line counts are only recorded when the agent/evidence
supports it—edit the description value that currently begins "AI
が書いたコードの「なぜ」を、git が忘れないために。" to include the conditional phrasing (reference the
description string in website/src/content/docs/ja/index.mdx).

In `@website/src/content/docs/ko/index.mdx`:
- Line 43: 문장이 어색하게 혼용된 외래어·조사 사용으로 읽기 흐름이 끊깁니다; 해당 문장("AI Ratio, 프롬프트 수, 커밋 해시와
AI Review tool 용 hidden Reviewer Context 를 함께 담습니다.")을 사용자 문서 톤으로 자연스럽게 고쳐 "AI
비율, 프롬프트 수, 커밋 해시 및 AI 리뷰 도구용 숨겨진 리뷰어 컨텍스트를 함께 포함합니다."처럼 외래어는 한국어화(예: "Review
tool"→"리뷰 도구", "hidden Reviewer Context"→"숨겨진 리뷰어 컨텍스트")하고 조사/띄어쓰기를 정리해 교체해 주세요.

In `@website/src/content/docs/ru/index.mdx`:
- Line 43: Коротко: убрать внутренний жаргон из фразы "скрытый Reviewer Context
для AI Review tools" и заменить её на понятное пользователю описание ценности;
найдите строку с этой фразой в тексте (в блоке, где перечисляются преимущества:
"AI Ratio, prompts, хеши коммитов и ...") и замените внутренние термины на
user-facing формулировку вроде "добавочный контекст для ревью в PR" или
"дополнительный контекст для обзора кода в PR", сохранив общий смысл про помощь
при ревью, без упоминания внутренних инструментов или англоязычного жаргона.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6a75d2d5-305d-4af7-b6c3-edc260a67d9a

📥 Commits

Reviewing files that changed from the base of the PR and between 4da3125 and 724e4b7.

📒 Files selected for processing (30)
  • README.de.md
  • README.es.md
  • README.fr.md
  • README.id.md
  • README.it.md
  • README.ja.md
  • README.ko.md
  • README.md
  • README.pt-br.md
  • README.ru.md
  • README.zh-cn.md
  • README.zh-tw.md
  • website/src/content/docs/de/github-action.mdx
  • website/src/content/docs/de/index.mdx
  • website/src/content/docs/de/troubleshooting.mdx
  • website/src/content/docs/es/index.mdx
  • website/src/content/docs/fr/data-and-privacy.mdx
  • website/src/content/docs/fr/github-action.mdx
  • website/src/content/docs/fr/index.mdx
  • website/src/content/docs/id/github-action.mdx
  • website/src/content/docs/id/index.mdx
  • website/src/content/docs/index.mdx
  • website/src/content/docs/it/github-action.mdx
  • website/src/content/docs/it/index.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/pt-br/index.mdx
  • website/src/content/docs/ru/index.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-tw/index.mdx

Comment thread README.pt-br.md Outdated
Comment thread website/src/content/docs/de/troubleshooting.mdx
Comment thread website/src/content/docs/fr/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/fr/github-action.mdx
Comment thread website/src/content/docs/id/github-action.mdx
Comment thread website/src/content/docs/it/github-action.mdx
Comment thread website/src/content/docs/ja/index.mdx Outdated
Comment thread website/src/content/docs/ko/index.mdx Outdated
Comment thread website/src/content/docs/ru/index.mdx Outdated
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 11

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@website/src/content/docs/de/data-and-privacy.mdx`:
- Line 26: Update the table row for `attribution` to include a conditional
qualifier in German to match the Japanese/other locales (i.e., indicate that
line counts are only shown when available); locate the `attribution` entry in
the docs table and append a phrase such as "ggf. Zeilenangaben" or
"Zeilenangaben, wenn verfügbar" to the description so it reads e.g. "AI Ratio,
Methode und ggf. Zeilenangaben".

In `@website/src/content/docs/es/data-and-privacy.mdx`:
- Line 26: Update the Spanish table row for `attribution` to match other locales
by adding the "when available" qualifier; locate the `attribution` entry that
currently reads "AI Ratio, método y conteos de líneas" and change it to include
a conditional phrase such as "AI Ratio, método y conteos de líneas (cuando esté
disponible)" so it clearly indicates line counts are provided only when
available.

In `@website/src/content/docs/fr/data-and-privacy.mdx`:
- Line 26: Update the table row for the `attribution` entry that currently reads
"AI Ratio, méthode et compteurs de lignes" to include a "when available"
qualifier for parity with other locales; keep "AI Ratio" unchanged and append a
French qualifier such as "lorsque disponible" or "si disponible" (e.g., "AI
Ratio, méthode et compteurs de lignes (lorsque disponible)"), ensuring the
phrase appears where the `attribution` table cell text is defined.

In `@website/src/content/docs/id/data-and-privacy.mdx`:
- Line 26: Update the Indonesian `attribution` table entry to include the
conditional qualifier analogous to the Japanese version; change the cell text
for `attribution` (currently "AI Ratio, metode, dan jumlah baris") to include
"bila tersedia" (e.g., "AI Ratio, metode, dan jumlah baris bila tersedia") so
the wording clearly indicates line counts are only shown when available and
restores locale parity.

In `@website/src/content/docs/it/data-and-privacy.mdx`:
- Line 26: Update the Italian docs table row for the `attribution` entry to
match other locales by adding a "when available" qualifier: locate the table
cell containing "`attribution` | AI Ratio, metodo e conteggio delle righe" and
change the description to include a phrase like "AI Ratio (quando disponibile),
metodo e conteggio delle righe" so it reads that line counts are conditional
while keeping "AI Ratio" untranslated.

In `@website/src/content/docs/ja/index.mdx`:
- Line 43: Replace the internal-sounding phrase "hidden Reviewer Context" in the
JA doc with a natural, user-facing Japanese term (e.g., 「レビュワー専用の非表示コンテキスト」 or
「表示されないレビュワー用情報」) so the sentence reads naturally and is locale-appropriate;
update the line containing "hidden Reviewer Context" to use the chosen Japanese
phrasing, keeping meaning clear to users and avoiding maintainer/internal jargon
while maintaining parity with the EN copy and other docs.

In `@website/src/content/docs/ko/troubleshooting.mdx`:
- Line 41: Replace the mixed-English phrase "edit evidence" with natural Korean
wording in the table cell that currently reads "Line Estimate 가 보이지 않음 | Agent 가
충분한 edit evidence 를 제공할 수 있는지 확인" (also update the same phrase at the second
occurrence noted around the file). Change it to a fluent Korean phrase such as
"수정 증거" or "편집 증빙" (pick the most natural phrasing used elsewhere) so the full
row reads e.g. "Line Estimate 가 보이지 않음 | Agent 가 충분한 수정 증거를 제공할 수 있는지 확인", and
apply the same replacement at the other occurrence.

In `@website/src/content/docs/pt-br/data-and-privacy.mdx`:
- Line 26: Update the attribution table row that currently reads "`attribution`
| AI Ratio, método e contagem de linhas" to include a "when available" qualifier
for the line-counts while preserving the canonical product term "AI Ratio"
untranslated; specifically modify the table cell string for the `attribution`
entry (the row containing "`attribution` | AI Ratio, método e contagem de
linhas") to something like "AI Ratio, método e contagem de linhas (quando
disponível)" so it matches the parity used in other locales.

In `@website/src/content/docs/pt-br/troubleshooting.mdx`:
- Line 52: The phrase "nenhum Agent Note data foi encontrado" reads hybrid;
update the sentence so the surrounding Portuguese is natural while keeping the
English literal "Agent Note data" as requested — e.g., change the fragment to
"não foram encontrados 'Agent Note data' para eles" so the full line reads: "Se
o header mostrar `Total AI Ratio: —` e `Agent Note data: No tracked commits`, a
PR tem commits, mas não foram encontrados 'Agent Note data' para eles. Isso é
diferente de um AI Ratio real de `0%`."

In `@website/src/content/docs/ru/agent-support.mdx`:
- Line 75: Replace the English word “denominator” with a localized Russian term
in the sentence that mentions AI Ratio; specifically change the phrase
"исключаются только из denominator AI Ratio" to use "знаменателя" (e.g.,
"исключаются только из знаменателя AI Ratio") while keeping "AI Ratio" canonical
and leaving the rest of the sentence unchanged to preserve meaning and locale
parity.

In `@website/src/content/docs/zh-cn/troubleshooting.mdx`:
- Around line 94-97: The Chinese "## Line Estimate 没有显示" troubleshooting section
diverges from the English source in structure (paragraph vs. English bullet
list), includes an extra sentence about fallback behavior ("当证据不足时,Agent Note
会回退到保守判定,而不是猜测") and omits line 98 in the snippet; to fix, make the Chinese and
English versions identical by either (A) updating the English doc to add the
fallback sentence and convert its lines 107-114 into the same paragraph/format
used in the Chinese file, or (B) changing the Chinese "## Line Estimate 没有显示"
block to match the English exactly by converting it to the same bullet-point
structure and removing the extra fallback sentence, and ensure the full fallback
explanation (the line referenced as line 98) is present or removed consistently
across both locales.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1711e62d-13bf-4556-8340-d6eede66a948

📥 Commits

Reviewing files that changed from the base of the PR and between 724e4b7 and dc41efa.

📒 Files selected for processing (69)
  • README.id.md
  • README.it.md
  • README.ko.md
  • README.md
  • README.pt-br.md
  • README.ru.md
  • website/src/content/docs/agent-support.mdx
  • website/src/content/docs/commands.mdx
  • website/src/content/docs/data-and-privacy.mdx
  • website/src/content/docs/de/agent-support.mdx
  • website/src/content/docs/de/data-and-privacy.mdx
  • website/src/content/docs/de/how-it-works.mdx
  • website/src/content/docs/de/troubleshooting.mdx
  • website/src/content/docs/es/agent-support.mdx
  • website/src/content/docs/es/data-and-privacy.mdx
  • website/src/content/docs/es/github-action.mdx
  • website/src/content/docs/es/how-it-works.mdx
  • website/src/content/docs/es/troubleshooting.mdx
  • website/src/content/docs/fr/agent-support.mdx
  • website/src/content/docs/fr/data-and-privacy.mdx
  • website/src/content/docs/fr/github-action.mdx
  • website/src/content/docs/fr/how-it-works.mdx
  • website/src/content/docs/fr/troubleshooting.mdx
  • website/src/content/docs/getting-started.mdx
  • website/src/content/docs/github-action.mdx
  • website/src/content/docs/how-it-works.mdx
  • website/src/content/docs/id/agent-support.mdx
  • website/src/content/docs/id/data-and-privacy.mdx
  • website/src/content/docs/id/github-action.mdx
  • website/src/content/docs/id/how-it-works.mdx
  • website/src/content/docs/id/troubleshooting.mdx
  • website/src/content/docs/it/agent-support.mdx
  • website/src/content/docs/it/data-and-privacy.mdx
  • website/src/content/docs/it/github-action.mdx
  • website/src/content/docs/it/how-it-works.mdx
  • website/src/content/docs/it/troubleshooting.mdx
  • website/src/content/docs/ja/agent-support.mdx
  • website/src/content/docs/ja/data-and-privacy.mdx
  • website/src/content/docs/ja/getting-started.mdx
  • website/src/content/docs/ja/github-action.mdx
  • website/src/content/docs/ja/how-it-works.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ja/troubleshooting.mdx
  • website/src/content/docs/ko/agent-support.mdx
  • website/src/content/docs/ko/data-and-privacy.mdx
  • website/src/content/docs/ko/how-it-works.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/ko/troubleshooting.mdx
  • website/src/content/docs/pt-br/agent-support.mdx
  • website/src/content/docs/pt-br/data-and-privacy.mdx
  • website/src/content/docs/pt-br/how-it-works.mdx
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/ru/agent-support.mdx
  • website/src/content/docs/ru/data-and-privacy.mdx
  • website/src/content/docs/ru/github-action.mdx
  • website/src/content/docs/ru/how-it-works.mdx
  • website/src/content/docs/ru/index.mdx
  • website/src/content/docs/ru/troubleshooting.mdx
  • website/src/content/docs/troubleshooting.mdx
  • website/src/content/docs/zh-cn/agent-support.mdx
  • website/src/content/docs/zh-cn/data-and-privacy.mdx
  • website/src/content/docs/zh-cn/github-action.mdx
  • website/src/content/docs/zh-cn/how-it-works.mdx
  • website/src/content/docs/zh-cn/troubleshooting.mdx
  • website/src/content/docs/zh-tw/agent-support.mdx
  • website/src/content/docs/zh-tw/data-and-privacy.mdx
  • website/src/content/docs/zh-tw/github-action.mdx
  • website/src/content/docs/zh-tw/how-it-works.mdx
  • website/src/content/docs/zh-tw/troubleshooting.mdx

Comment thread website/src/content/docs/de/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/es/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/fr/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/id/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/it/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/ko/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/pt-br/data-and-privacy.mdx Outdated
Comment thread website/src/content/docs/pt-br/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/ru/agent-support.mdx Outdated
Comment thread website/src/content/docs/zh-cn/troubleshooting.mdx
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

♻️ Duplicate comments (1)
website/src/content/docs/ko/index.mdx (1)

43-43: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use clearer Korean wording for the user-facing PR report card text.

Line 43 still mixes internal/jargon-heavy English terms (tool, Context) in prose, which hurts readability for public docs.

✍️ Suggested wording update
-    AI Ratio, 프롬프트 수, 커밋 해시와 함께 AI Review tool 이 읽을 수 있는 숨겨진 보조 Context 도 담습니다.
+    AI Ratio, 프롬프트 수, 커밋 해시와 함께 AI 리뷰 도구가 참고할 수 있는 숨겨진 보조 정보도 담습니다.

As per coding guidelines website/**: “Review documentation for implementation accuracy, natural language, locale parity, and clear separation between user-facing guidance and maintainer details.”

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@website/src/content/docs/ko/index.mdx` at line 43, The sentence "AI Ratio,
프롬프트 수, 커밋 해시와 함께 AI Review tool 이 읽을 수 있는 숨겨진 보조 Context 도 담습니다." mixes English
jargon and has spacing/grammar issues; update this user-facing line to natural
Korean by replacing "tool" and "Context" with Korean terms (예: "도구", "맥락" or
"문맥"), fix spacing around particles, and make it simple and
passive/neutral—e.g., rewrite the fragment to something like "AI 비율, 프롬프트 수, 커밋
해시와 함께 AI 리뷰 도구가 읽을 수 있는 숨겨진 보조 문맥도 포함합니다."—apply this change to the exact
sentence in the content so the public-facing PR report card reads clearly in
Korean.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@website/src/content/docs/pt-br/troubleshooting.mdx`:
- Around line 96-97: Replace the single long paragraph starting with "Isso
costuma ser normal." with a short bulleted list (pt-BR) that mirrors other
locales: one bullet for "Claude Code" explaining it usually provides sufficient
evidence for Line Estimate; one for "Codex CLI" stating it can only estimate
when transcript patch counts match the final commit diff; one for "Cursor"
stating it can only estimate when edit counts match and the final file
corresponds to the AI's last edit; and one for "Gemini CLI" noting it currently
only shows AI Ratio per file; preserve the original Portuguese phrasing and any
nuance, keep user-facing wording concise, and ensure the new bullets follow the
repository docs style and locale parity.

In `@website/src/content/docs/zh-cn/index.mdx`:
- Line 43: The sentence mixes English terms into Chinese—replace the English
phrases "AI Review tool" and "Context" with Chinese equivalents (e.g., "AI 审查工具"
and "上下文") while keeping "AI Ratio" unchanged; update the line containing "AI
Ratio、提示词数量、commit 哈希,以及供 AI Review tool 读取的隐藏补充 Context。" to a localized
version such as "AI Ratio、提示词数量、commit 哈希,以及供 AI 审查工具读取的隐藏补充上下文。" ensuring the
exact occurrences of "AI Review tool" and "Context" are replaced and the overall
sentence remains natural in zh-CN.

In `@website/src/content/docs/zh-tw/index.mdx`:
- Line 43: The sentence contains English terms "AI Review tool" and "Context"
that should be localized for zh-TW consistency; replace them with natural
Chinese equivalents (e.g., "AI 審查工具" for "AI Review tool" and "情境" or "補充情境" for
"Context") so the line reads smoothly in zh-TW (for example: "AI
Ratio、提示詞數量、commit 雜湊值,以及供 AI 審查工具讀取的隱藏補充情境。"), updating the exact string that
currently includes "AI Review tool" and "Context".

---

Duplicate comments:
In `@website/src/content/docs/ko/index.mdx`:
- Line 43: The sentence "AI Ratio, 프롬프트 수, 커밋 해시와 함께 AI Review tool 이 읽을 수 있는
숨겨진 보조 Context 도 담습니다." mixes English jargon and has spacing/grammar issues;
update this user-facing line to natural Korean by replacing "tool" and "Context"
with Korean terms (예: "도구", "맥락" or "문맥"), fix spacing around particles, and
make it simple and passive/neutral—e.g., rewrite the fragment to something like
"AI 비율, 프롬프트 수, 커밋 해시와 함께 AI 리뷰 도구가 읽을 수 있는 숨겨진 보조 문맥도 포함합니다."—apply this change
to the exact sentence in the content so the public-facing PR report card reads
clearly in Korean.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: f1ff6da7-2fb5-4bf8-9b5d-e2a8ec1fd6fd

📥 Commits

Reviewing files that changed from the base of the PR and between dc41efa and da44079.

📒 Files selected for processing (18)
  • README.id.md
  • README.ja.md
  • website/src/content/docs/de/data-and-privacy.mdx
  • website/src/content/docs/es/data-and-privacy.mdx
  • website/src/content/docs/fr/data-and-privacy.mdx
  • website/src/content/docs/id/agent-support.mdx
  • website/src/content/docs/id/data-and-privacy.mdx
  • website/src/content/docs/it/data-and-privacy.mdx
  • website/src/content/docs/ja/index.mdx
  • website/src/content/docs/ko/index.mdx
  • website/src/content/docs/ko/troubleshooting.mdx
  • website/src/content/docs/pt-br/data-and-privacy.mdx
  • website/src/content/docs/pt-br/troubleshooting.mdx
  • website/src/content/docs/ru/agent-support.mdx
  • website/src/content/docs/zh-cn/index.mdx
  • website/src/content/docs/zh-cn/troubleshooting.mdx
  • website/src/content/docs/zh-tw/index.mdx
  • website/src/content/docs/zh-tw/troubleshooting.mdx

Comment thread website/src/content/docs/pt-br/troubleshooting.mdx Outdated
Comment thread website/src/content/docs/zh-cn/index.mdx Outdated
Comment thread website/src/content/docs/zh-tw/index.mdx Outdated
@wasabeef wasabeef merged commit abf84aa into main May 10, 2026
11 checks passed
@wasabeef wasabeef deleted the docs/publish-doc-refresh branch May 10, 2026 14:41
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