Skip to content

docs: unify internal docs in English#100

Merged
harumiWeb merged 3 commits intomainfrom
issue-98-docs-english
Mar 15, 2026
Merged

docs: unify internal docs in English#100
harumiWeb merged 3 commits intomainfrom
issue-98-docs-english

Conversation

@harumiWeb
Copy link
Owner

@harumiWeb harumiWeb commented Mar 15, 2026

Summary

  • translate AGENTS.md into English
  • translate the remaining internal documentation under dev-docs/ into English
  • sync ADR index artifacts so README, decision-map, and index metadata use the translated titles

Verification

  • uv run task precommit-run
  • search for remaining Japanese text in AGENTS.md
  • search for remaining Japanese text in dev-docs/**/*.{md,yaml,yml}

Notes

  • uv run task test-unit failed during collection in this environment because anyio is missing from the active uv environment, even though it exists in uv.lock.

Closes #98


Open with Devin

Summary by CodeRabbit

  • Documentation
    • Large-scale localization: converted developer guides, ADRs, architecture & pipeline docs, specs (data model, Excel extraction, patch notes), testing requirements, agent guides, and contributor/coding guidelines from Japanese to English; headings, section labels and examples updated for clearer, consistent wording and navigation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 15, 2026

📝 Walkthrough

Walkthrough

This PR localizes repository documentation from Japanese to English across AGENTS.md and the dev-docs/ tree (ADRs, specs, architecture, agents, testing). Changes are text-only (headings, prose, templates); no code, API, or runtime behavior was modified.

Changes

Cohort / File(s) Summary
Root documentation
AGENTS.md
Full translation from Japanese to English; structure preserved.
ADR framework
dev-docs/adr/README.md, dev-docs/adr/template.md, dev-docs/adr/decision-map.md, dev-docs/adr/ADR-0001-extraction-mode-boundaries.md, dev-docs/adr/ADR-0002-rich-backend-fallback-policy.md, dev-docs/adr/ADR-0003-output-serialization-omission-policy.md, dev-docs/adr/ADR-0004-patch-backend-selection-policy.md, dev-docs/adr/ADR-0005-path-policy-safety-boundary.md, dev-docs/adr/index.yaml
Translated ADR titles, headers, and bodies to English; template gained explicit "Supersedes"/"Superseded by" and expanded rationale/testing/code bullets; index.yaml titles updated.
Agent-facing docs
dev-docs/agents/...
dev-docs/agents/README.md, dev-docs/agents/adr-criteria.md, dev-docs/agents/adr-governance.md, dev-docs/agents/adr-workflow.md, dev-docs/agents/coding-guidelines.md, dev-docs/agents/contributing.md, dev-docs/agents/overview.md, dev-docs/agents/roadmap.md
Comprehensive English localization; README reading list expanded; governance, workflow, guidelines, contributing, overview, and roadmap rewritten in English.
Architecture docs
dev-docs/architecture/...
dev-docs/architecture/README.md, dev-docs/architecture/contributor-guide.md, dev-docs/architecture/overview.md, dev-docs/architecture/pipeline.md
Architecture docs translated and reorganized into English; pipeline doc clarified with backend distinctions, fallbacks, and extension points; contributor guide expanded.
Specifications
dev-docs/specs/...
dev-docs/specs/README.md, dev-docs/specs/adr-index.md, dev-docs/specs/adr-review.md, dev-docs/specs/data-model.md, dev-docs/specs/excel-extraction.md, dev-docs/specs/patch/*
Specs translated to English; ADR index contract extended (added fields: path, domains, supersedes, superseded_by); data model and Excel extraction spec wording clarified.
Testing docs
dev-docs/testing/README.md, dev-docs/testing/test-requirements.md
Test requirements and README translated to English; content and test targets preserved.
Patch/legacy docs
dev-docs/specs/patch/legacy-dependency-inventory.md, dev-docs/specs/patch/model-migration-notes.md
Phase/patch migration and legacy inventory docs translated to English and rephrased for clarity.
Top-level manifests
dev-docs/adr/index.yaml
ADR titles switched to English; other metadata unchanged.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested labels

documentation

Poem

🐰 I hopped through docs and chased each kanji away,
Swapped words for English so the whole world can play.
I left every function sleeping, untouched in its den,
Just polished the pages—one tidy hop then. 🥕📚

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description provides a clear summary of changes, verification steps, and notes about environment issues. However, it does not follow the required template structure with Acceptance Criteria sections and validation checkboxes from the repository template. Update the PR description to follow the repository template format, including the Summary section, Acceptance Criteria checklist, and Validation checklist.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The PR title 'docs: unify internal docs in English' clearly summarizes the main change: translating internal documentation from Japanese to English while maintaining structure and semantics.
Linked Issues check ✅ Passed The PR addresses all coding requirements from linked issue #98: translates AGENTS.md into English, translates dev-docs/ into English, and syncs ADR index artifacts with translated titles. All objectives are met.
Out of Scope Changes check ✅ Passed All changes are within scope: file modifications are strictly documentation translations from Japanese to English across AGENTS.md, dev-docs/ files, and ADR metadata. No unrelated code or feature changes are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch issue-98-docs-english
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

This comment was marked as resolved.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
coderabbitai[bot]

This comment was marked as resolved.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copy link
Contributor

@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.

🧹 Nitpick comments (1)
dev-docs/architecture/pipeline.md (1)

44-49: Consider removing duplicated RichBackend clarification text.

The same conceptual-vs-concrete explanation appears on Line 44 and again on Line 48. Keeping it once will improve readability.

✂️ Proposed doc cleanup
-3. **Rich Backend** extracts shapes/charts if available. Here, `RichBackend` is the conceptual layer and `ComRichBackend` / `LibreOfficeRichBackend` are the concrete implementations.
+3. **Rich Backend** extracts shapes/charts if available.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@dev-docs/architecture/pipeline.md` around lines 44 - 49, The doc duplicates
the conceptual-vs-concrete explanation for RichBackend; remove the redundant
sentence so the clarification about RichBackend vs its concrete implementations
appears only once (keep a single clear mention of RichBackend and its concrete
types ComRichBackend and LibreOfficeRichBackend), ensuring references to
RichBackend, ComRichBackend, and LibreOfficeRichBackend remain present in the
retained sentence and adjusting surrounding numbering/flow so the list remains
contiguous.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@dev-docs/architecture/pipeline.md`:
- Around line 44-49: The doc duplicates the conceptual-vs-concrete explanation
for RichBackend; remove the redundant sentence so the clarification about
RichBackend vs its concrete implementations appears only once (keep a single
clear mention of RichBackend and its concrete types ComRichBackend and
LibreOfficeRichBackend), ensuring references to RichBackend, ComRichBackend, and
LibreOfficeRichBackend remain present in the retained sentence and adjusting
surrounding numbering/flow so the list remains contiguous.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 197d72a9-c48f-41fd-a53a-954011553f47

📥 Commits

Reviewing files that changed from the base of the PR and between f253797 and 41d93c2.

📒 Files selected for processing (2)
  • dev-docs/architecture/pipeline.md
  • dev-docs/testing/test-requirements.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • dev-docs/testing/test-requirements.md

@harumiWeb harumiWeb merged commit 75b3c32 into main Mar 15, 2026
12 checks passed
@harumiWeb harumiWeb deleted the issue-98-docs-english branch March 15, 2026 06:45
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.

We will unify the documentation in English.

3 participants