-
Notifications
You must be signed in to change notification settings - Fork 5
feat: add translation agent guide (AGENTS.md) in English #229
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
base: master
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughTwo documentation files are added to establish guidelines for AI-assisted translation workflows. The root-level AGENTS.md outlines FreeCodeCamp Chengdu Community Wiki conventions, while _drafts/Article/Translation/AGENTS.md details the AI-assisted translation process, including quality standards, chunked translation strategy, glossary creation, and practical workflow examples for translating English tech articles to Chinese. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this 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
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
AGENTS.md_drafts/Article/Translation/AGENTS.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
_drafts/Article/Translation/AGENTS.md
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
89-89: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
108-108: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🔇 Additional comments (2)
AGENTS.md (1)
1-47: Clear and well-structured translation guidelines.The root AGENTS.md file provides excellent foundational guidance for contributors. The project structure, workflow steps, and front matter format are clearly documented. The reference to the detailed AI translation guide for long articles provides a logical progression from high-level overview to detailed implementation.
_drafts/Article/Translation/AGENTS.md (1)
1-60: Comprehensive and practical AI translation guide.This document provides excellent detailed guidance for AI-assisted translation workflows. The chunked translation strategy is well-explained and practical, the glossary approach ensures terminology consistency, and the style guide covers essential aspects of Chinese technical writing. The concrete examples and terminology reference are particularly valuable for translators.
Also applies to: 68-148
| ``` | ||
| === Translation Unit [N/Total] === | ||
| Section: [Section Title] | ||
| Line Range: [Start-End] | ||
| Status: [Pending/In Progress/Completed] | ||
| === | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add language specifications to fenced code blocks.
Three fenced code blocks are missing language identifiers. Specify the language for proper syntax highlighting and consistency with Markdown best practices.
🔎 Proposed fix for fenced code block language specifications
- ```
+ ```text
=== Translation Unit [N/Total] ===- ```
+ ```text
First occurrence: 服务端渲染(Server-Side Rendering,SSR)- ```
+ ```text
1. Analyze structure:Also applies to: 89-92, 108-125
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
61-61: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In _drafts/Article/Translation/AGENTS.md around lines 61-67 (also apply same fix
to 89-92 and 108-125), several fenced code blocks are missing language
identifiers; update each opening triple-backtick to include an appropriate
language tag (e.g., text or markdown, or `text` for plain content and
`zh`/`zh-CN` if you prefer locale-specific highlighting) so the blocks become
```text (or ```markdown/```zh-CN) to enable correct syntax highlighting and
maintain consistency.
@FreeCodeCamp-Chengdu/team-1
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.