158 lines
3.9 KiB
Markdown
158 lines
3.9 KiB
Markdown
---
|
|
name: first-time-setup
|
|
description: First-time setup flow for baoyu-translate preferences
|
|
---
|
|
|
|
# First-Time Setup
|
|
|
|
## Overview
|
|
|
|
When no EXTEND.md is found, guide user through preference setup.
|
|
|
|
**BLOCKING OPERATION**: This setup MUST complete before ANY translation. Do NOT:
|
|
- Start translating content
|
|
- Ask about files or output paths
|
|
- Proceed to any workflow steps
|
|
|
|
ONLY ask the questions in this setup flow, save EXTEND.md, then continue.
|
|
|
|
## Setup Flow
|
|
|
|
```
|
|
No EXTEND.md found
|
|
|
|
|
v
|
|
+---------------------+
|
|
| AskUserQuestion |
|
|
| (all questions) |
|
|
+---------------------+
|
|
|
|
|
v
|
|
+---------------------+
|
|
| Create EXTEND.md |
|
|
+---------------------+
|
|
|
|
|
v
|
|
Continue translation
|
|
```
|
|
|
|
## Questions
|
|
|
|
**Language**: Use user's input language or saved language preference.
|
|
|
|
Use AskUserQuestion with ALL questions in ONE call:
|
|
|
|
### Question 1: Target Language
|
|
|
|
```yaml
|
|
header: "Target Language"
|
|
question: "Default target language?"
|
|
options:
|
|
- label: "简体中文 zh-CN (Recommended)"
|
|
description: "Translate to Simplified Chinese"
|
|
- label: "繁體中文 zh-TW"
|
|
description: "Translate to Traditional Chinese"
|
|
- label: "English en"
|
|
description: "Translate to English"
|
|
- label: "日本語 ja"
|
|
description: "Translate to Japanese"
|
|
```
|
|
|
|
Note: User may type a custom language code.
|
|
|
|
### Question 2: Translation Mode
|
|
|
|
```yaml
|
|
header: "Mode"
|
|
question: "Default translation mode?"
|
|
options:
|
|
- label: "Normal (Recommended)"
|
|
description: "Analyze content first, then translate"
|
|
- label: "Quick"
|
|
description: "Direct translation, no analysis"
|
|
- label: "Refined"
|
|
description: "Full workflow: analyze → translate → review → polish"
|
|
```
|
|
|
|
### Question 3: Target Audience
|
|
|
|
```yaml
|
|
header: "Audience"
|
|
question: "Default target audience?"
|
|
options:
|
|
- label: "General readers (Recommended)"
|
|
description: "Plain language, more translator's notes for jargon"
|
|
- label: "Technical"
|
|
description: "Developers/engineers, less annotation on tech terms"
|
|
- label: "Academic"
|
|
description: "Formal register, precise terminology"
|
|
- label: "Business"
|
|
description: "Business-friendly tone, explain tech concepts"
|
|
```
|
|
|
|
Note: User may type a custom audience description.
|
|
|
|
### Question 4: Translation Style
|
|
|
|
```yaml
|
|
header: "Style"
|
|
question: "Translation style?"
|
|
options:
|
|
- label: "Storytelling (Recommended)"
|
|
description: "Engaging, narrative-like flow"
|
|
- label: "Formal"
|
|
description: "Professional, structured"
|
|
- label: "Technical"
|
|
description: "Precise, documentation-style"
|
|
- label: "Literal"
|
|
description: "Close to original structure"
|
|
```
|
|
|
|
### Question 5: Save Location
|
|
|
|
```yaml
|
|
header: "Save"
|
|
question: "Where to save preferences?"
|
|
options:
|
|
- label: "User (Recommended)"
|
|
description: "$HOME/.baoyu-skills/ (all projects)"
|
|
- label: "Project"
|
|
description: ".baoyu-skills/ (this project only)"
|
|
```
|
|
|
|
## Save Locations
|
|
|
|
| Choice | Path | Scope |
|
|
|--------|------|-------|
|
|
| User | `$HOME/.baoyu-skills/baoyu-translate/EXTEND.md` | All projects |
|
|
| Project | `.baoyu-skills/baoyu-translate/EXTEND.md` | Current project |
|
|
|
|
## After Setup
|
|
|
|
1. Create directory if needed
|
|
2. Write EXTEND.md with selected values
|
|
3. Confirm: "Preferences saved to [path]"
|
|
4. Mention: "You can add custom glossary terms to EXTEND.md anytime. See the `glossary` section in the file for the format."
|
|
5. Continue with translation using saved preferences
|
|
|
|
## EXTEND.md Template
|
|
|
|
```yaml
|
|
target_language: [zh-CN/zh-TW/en/ja/...]
|
|
default_mode: [quick/normal/refined]
|
|
audience: [general/technical/academic/business/custom]
|
|
style: [storytelling/formal/technical/literal]
|
|
|
|
# Custom glossary (optional) — add your own term translations here
|
|
# glossary:
|
|
# - from: "Term"
|
|
# to: "翻译"
|
|
# - from: "Another Term"
|
|
# to: "另一个翻译"
|
|
# note: "Usage context"
|
|
```
|
|
|
|
## Modifying Preferences Later
|
|
|
|
Users can edit EXTEND.md directly or delete it to trigger setup again.
|