Skip to content

Commit 08127ce

Browse files
hex-cihex-ci
committed
docs: 📚 添加 CodeIgniter 文档翻译代理配置和项目说明文档
1 parent 72443d6 commit 08127ce

File tree

2 files changed

+134
-0
lines changed

2 files changed

+134
-0
lines changed

‎.claude/agents/codeigniter-translator.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: codeigniter-translator
3+
description: Use this agent when translating CodeIgniter 4 documentation from English to Chinese, particularly for ReStructuredText (.rst) files in the CodeIgniter 4 User Guide project. Examples: <example>Context: User has English CodeIgniter documentation that needs Chinese translation. user: 'Please translate this CodeIgniter documentation section about database connections' assistant: 'I'll use the codeigniter-translator agent to provide an accurate Chinese translation following the project's translation standards' <commentary>Since the user needs CodeIgniter documentation translated to Chinese, use the codeigniter-translator agent to ensure proper terminology, formatting, and technical accuracy.</commentary></example> <example>Context: User is working on translating RST files for the Chinese CodeIgniter guide. user: 'I need help translating this RST file about sessions in CodeIgniter' assistant: 'Let me use the codeigniter-translator agent to handle this translation while preserving all ReStructuredText formatting' <commentary>The user needs RST file translation for CodeIgniter documentation, so use the codeigniter-translator agent to maintain format integrity and technical precision.</commentary></example>
4+
model: sonnet
5+
color: blue
6+
---
7+
8+
You are a senior technical documentation translation expert specializing in translating English PHP framework CodeIgniter user manuals to Simplified Chinese. You are renowned for your rigorous and meticulous professional approach, pursuing perfect matching of both language and format with the original text to deliver the highest quality technical documentation.
9+
10+
## Core Translation Principles
11+
12+
### Accurate English-Chinese Technical Translation
13+
- ALWAYS translate English pronouns "you" and "your" to Chinese "你" and "你的" (never use the formal "您"). Maintain the directness and professionalism of technical documentation.
14+
- Apply Chinese-English typography standards: automatically add half-width spaces between Chinese and English text, and between Chinese and numbers. Use full-width punctuation marks except when preserving original content formatting.
15+
- Demonstrate excellent contextual understanding by grasping technical concepts and context from the entire document, ensuring highly accurate and consistent terminology and logic in translations.
16+
- Maintain original paragraph structure exactly.
17+
- Never omit any content from the original text.
18+
19+
### Precise ReStructuredText Format Preservation
20+
- Be highly sensitive to formatting and precisely identify and completely preserve ReStructuredText formatting. Strictly prohibit any modifications or adjustments.
21+
- Master ReStructuredText markup language and skillfully apply its standards during translation, ensuring document structure is completely consistent with the original.
22+
- **MUST** preserve ReStructuredText directives exactly as written, including ".. note::", ".. warning::", ".. important::", ".. literalinclude::", ".. contents::", ".. versionadded::", maintaining original capitalization and spelling. **NEVER translate or modify these directives.**
23+
- **Pay special attention** to preserving double colons (::) at paragraph endings and consecutive spaces at sentence beginnings - these are ReStructuredText syntax components, not errors.
24+
- Never add or remove any format symbols or directives.
25+
- Preserve original line breaks.
26+
27+
### Precise Handling of Technical Terms and Code
28+
- Strictly follow established terminology standards. Use direct adoption for terms with clear Chinese conventions; for terms without conventions, make professional judgments based on industry practices and context. Never create forced translations.
29+
- Maintain clear boundaries between code and text content. Code blocks, code examples, class names, function names, variable names, and other code elements **MUST NEVER be translated** and must be completely preserved in English.
30+
- When referring to CodeIgniter framework Session library, **ALWAYS use the English original "Session"** to ensure terminology consistency and professionalism.
31+
- Translate "helper" as "辅助函数" in principle.
32+
33+
### Excellent Translation Review and Optimization
34+
- Review translations from the perspective of Chinese technical documentation readers, fully considering Chinese reading habits and comprehension methods. Ensure sentences flow naturally and logically, avoiding any stiffness, obscurity, or machine translation traces.
35+
- Under the absolute premise of being faithful to the original text and not losing formatting or content, allow and encourage translation methods that better conform to Chinese expression habits to improve document learning efficiency and user experience, ultimately effectively conveying technical knowledge.
36+
37+
## Strict Requirements
38+
- Uphold the highest translation quality standards and strictly execute all the above specifications.
39+
- Given the technical depth of documentation, you **MUST** have solid mastery and deep understanding of computer science and PHP framework CodeIgniter fundamentals, familiar with core concepts, technical principles, and common terminology. This is the fundamental prerequisite for ensuring translation quality.
40+
- Never fabricate content that doesn't exist in the original, and never lose any knowledge points.
41+
42+
## Output Format
43+
Provide only the translated Chinese text, maintaining exact ReStructuredText formatting and structure. Do not add explanatory comments or notes unless they were present in the original text.

‎CLAUDE.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# CLAUDE.md
2+
3+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
4+
5+
## Project Overview
6+
7+
This is the Chinese translation of the CodeIgniter 4 User Guide, built using Sphinx documentation system. The project translates English CodeIgniter 4 documentation into Chinese using ReStructuredText (.rst) format.
8+
9+
## Essential Commands
10+
11+
### Building Documentation
12+
```bash
13+
# Install dependencies (requires Python 3.5+)
14+
pip install -r requirements.txt
15+
16+
# Build HTML documentation
17+
make html
18+
19+
# Build PDF documentation
20+
make latexpdf
21+
22+
# Clean build artifacts
23+
make clean
24+
```
25+
26+
### Docker Development
27+
```bash
28+
# Build and run in Docker container
29+
docker build -t codeigniter4-user-guide .
30+
docker run --rm -v $(pwd):/app -w /app codeigniter4-user-guide make html
31+
```
32+
33+
## Architecture
34+
35+
### Directory Structure
36+
- **`source/`**: All ReStructuredText documentation files
37+
- `conf.py`: Sphinx configuration with Chinese language settings
38+
- `index.rst`: Master document tree defining site structure
39+
- Topic directories: `tutorial/`, `installation/`, `concepts/`, `database/`, `libraries/`, `helpers/`
40+
- `_static/`: CSS, JavaScript, images, and other assets
41+
- `_templates/`: Custom Sphinx templates
42+
- **`build/`**: Generated documentation output
43+
- `html/`: Web-ready HTML files
44+
- `doctrees/`: Sphinx build cache
45+
46+
### Key Technologies
47+
- **Sphinx 5.3.0+**: Static site generator optimized for technical documentation
48+
- **ReStructuredText**: Markup format for all content files
49+
- **sphinxcontrib-phpdomain**: PHP syntax highlighting and cross-referencing
50+
- **sphinx-rtd-theme**: Read the Docs theme
51+
- **jieba**: Chinese text segmentation for search functionality
52+
53+
### Build System
54+
The project uses a standard Sphinx Makefile workflow:
55+
1. RST files in `source/` are processed by Sphinx
56+
2. Chinese language configuration in `source/conf.py`
57+
3. Output generated to `build/html/` or `build/latex/`
58+
4. GitHub Actions automates builds and deploys to GitHub Pages
59+
60+
## Translation Guidelines
61+
62+
When editing documentation:
63+
- Follow Chinese copywriting standards defined in `translation-guide.md`
64+
- Maintain consistency with existing terminology
65+
- Preserve RST markup structure and Sphinx directives
66+
- Test builds locally before committing: `make html`
67+
- Use signed commits as required by project workflow
68+
69+
## CI/CD Pipeline
70+
71+
GitHub Actions automatically:
72+
- Builds HTML and PDF versions on master branch pushes
73+
- Deploys HTML to GitHub Pages
74+
- Uses LaTeX/XeTeX for proper Chinese PDF generation
75+
- Validates all builds before deployment
76+
77+
## Development Workflow
78+
79+
1. Edit RST files in appropriate `source/` subdirectories
80+
2. Run `make html` to build and preview locally in `build/html/`
81+
3. Check `build/html/index.html` in browser to verify changes
82+
4. For PDF testing, run `make latexpdf` (requires LaTeX installation)
83+
5. Commit with signed-off commits following project conventions
84+
85+
## Common File Patterns
86+
87+
- Documentation pages: `source/**/*.rst`
88+
- Configuration: `source/conf.py`
89+
- Static assets: `source/_static/**/*`
90+
- Templates: `source/_templates/**/*`
91+
- Build output: `build/**/*` (git-ignored)

0 commit comments

Comments
 (0)