Conversation
bnbong
added
documentation
Owner
Author
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Completes the Korean (ko) documentation rollout and updates localization policy/status docs to reflect the current phased workflow, including clarifying that the repository-root CHANGELOG.md remains the canonical English release history.
Changes:
- Added a full Korean documentation set under
docs/ko/(user guide, tutorials, contributing, reference). - Updated English/Korean translation policy & status pages (phased rollout, source-of-truth, changelog wrapper policy).
- Tweaked docs rendering/tooling (Termynal prompt handling in
custom.js, markdown list spacing, pre-commit whitespace behavior).
Reviewed changes
Copilot reviewed 38 out of 38 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ko/user-guide/using-templates.md | Adds Korean user guide page for template discovery/usage. |
| docs/ko/user-guide/quick-start.md | Adds Korean quick start guide and workflow examples. |
| docs/ko/user-guide/installation.md | Adds Korean installation guide and troubleshooting. |
| docs/ko/user-guide/creating-projects.md | Adds Korean project creation guide incl. stacks/package managers. |
| docs/ko/user-guide/cli-reference.md | Adds Korean CLI reference and common workflows. |
| docs/ko/user-guide/choosing-a-starter.md | Adds Korean starter selection guide aligned with presets/templates. |
| docs/ko/user-guide/adding-routes.md | Adds Korean guide for addroute behavior and customization. |
| docs/ko/tutorial/getting-started.md | Adds Korean end-to-end beginner tutorial. |
| docs/ko/tutorial/domain-starter.md | Adds Korean tutorial for domain-starter layout and extension flow. |
| docs/ko/tutorial/basic-api-server.md | Adds Korean tutorial using fastapi-default template. |
| docs/ko/tutorial/async-crud-api.md | Adds Korean async CRUD tutorial with testing/perf examples. |
| docs/ko/reference/translation-status.md | Updates Korean translation status and explains fallback/changelog policy. |
| docs/ko/reference/template-quality-assurance.md | Adds Korean reference for template QA/inspection/testing. |
| docs/ko/reference/preset-feature-matrix.md | Adds Korean preset/feature contract matrix reference. |
| docs/ko/reference/faq.md | Adds Korean FAQ; includes CLI usage examples and policies. |
| docs/ko/contributing/translation-guide.md | Adds Korean translation guide and changelog policy. |
| docs/ko/contributing/template-creation-guide.md | Adds Korean template creation guide and validation steps. |
| docs/ko/contributing/code-guidelines.md | Adds Korean coding guidelines and tooling conventions. |
| docs/js/custom.js | Adjusts Termynal parsing for custom prompts without an end delimiter. |
| docs/en/user-guide/quick-start.md | Adds spacing before lists for readability/consistency. |
| docs/en/user-guide/creating-projects.md | Adds spacing before lists for readability/consistency. |
| docs/en/user-guide/adding-routes.md | Adds spacing before lists for readability/consistency. |
| docs/en/tutorial/getting-started.md | Adds spacing before lists for readability/consistency. |
| docs/en/tutorial/first-project.md | Adds spacing before lists for readability/consistency. |
| docs/en/reference/translation-status.md | Updates English translation status/policy (ko complete, changelog wrapper). |
| docs/en/reference/template-quality-assurance.md | Adds spacing before lists for readability/consistency. |
| docs/en/index.md | Adds spacing before lists for readability/consistency. |
| docs/en/contributing/translation-guide.md | Clarifies changelog wrapper policy in English guide. |
| docs/en/contributing/template-creation-guide.md | Adds spacing before lists for readability/consistency. |
| docs/en/contributing/development-setup.md | Adds spacing before lists for readability/consistency. |
| .pre-commit-config.yaml | Configures trailing-whitespace hook to respect Markdown linebreaks. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+305
to
+313
| $ fastkit addroute user | ||
| Adding New Route | ||
| ┌──────────────────┬──────────────────────────────────────────┐ | ||
| │ Project │ my-first-api │ | ||
| │ Route Name │ user │ | ||
| │ Target Directory │ /path/to/my-first-api │ | ||
| └──────────────────┴──────────────────────────────────────────┘ | ||
|
|
||
| Do you want to add route 'user' to the current project? [Y/n]: y |
Comment on lines
+121
to
+122
| $ fastkit addroute users . # 현재 디렉터리에 'users' 라우트 추가 | ||
| $ fastkit addroute users my-project # 'my-project' 에 'users' 라우트 추가 |
Comment on lines
67
to
86
| saveBuffer(); | ||
| const promptStart = line.indexOf(promptLiteralStart); | ||
| if (promptStart === -1) { | ||
| console.error("Custom prompt found but no end delimiter", line) | ||
| const value = "💬 " + line.replace(customPromptLiteralStart, "").trimEnd(); | ||
| useLines.push({ | ||
| value: value, | ||
| class: "termynal-comment", | ||
| delay: 0 | ||
| }); | ||
| } else { | ||
| const prompt = line | ||
| .slice(0, promptStart) | ||
| .replace(customPromptLiteralStart, ""); | ||
| const value = line.slice(promptStart + promptLiteralStart.length); | ||
| useLines.push({ | ||
| type: "input", | ||
| value: value, | ||
| prompt: prompt | ||
| }); | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requesting Merging
Description
Part of #59
Refs #60
Closes #62
This PR completes the Korean documentation localization rollout for FastAPI-fastkit and aligns the related translation policy/docs with the current localization workflow.
The main goal of this PR is to provide a complete Korean locale under
docs/ko/, improve readability and terminology consistency across translated pages, and clarify that the repository-rootCHANGELOG.mdremains the canonical English release history.Type of Change
Test Environment
uvuv run mkdocs buildDocumentation built successfullyMajor Changes
Completed the Korean docs locale under
docs/ko/26 / 26markdown pages presentImproved Korean readability and terminology consistency
Updated translation policy and status docs
docs/en/) as the source of truthClarified changelog handling for localized docs
CHANGELOG.mdas the canonical English release historydocs/ko/changelog.mdto act as a Korean entry point / wrapper for the canonical English changelog instead of maintaining a separate translated release historyRefined Korean docs navigation and cross-page consistency
Screenshots (optional)
N/A
Etc