Skip to content

Conversation

@bnbong
Copy link
Owner

@bnbong bnbong commented Nov 20, 2025

Requesting Merging

Description

Add AI translation script

Type of Change

  • BUG FIX
  • ADDING NEW TEMPLATE
  • FEATURE ADDED/UPDATED
  • HOTFIX
  • DELETING UNNECESSARY FEATURES
  • DOCUMENTATION & DEVOPS
  • Etc..

Test Environment

local, M1 Mac

Major Changes

  • now can translate docs/ materials with AI (currenlty, only OpenAI platform available. Other will added later.)

Screenshots (optional)

Etc

close #26

update src/fastapi_fastkit/cli.py : BaseCommand -> Command via deprecation.
reference : https://click.palletsprojects.com/en/stable/changes/#version-8-2-0

…fastapi_fastkit/cli.py via click package update
@bnbong bnbong self-assigned this Nov 20, 2025
@bnbong bnbong added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 20, 2025
@github-actions github-actions bot added the template Add or editing a FastAPI template label Nov 20, 2025
@codecov
Copy link

codecov bot commented Nov 20, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@bnbong bnbong requested a review from Copilot November 20, 2025 07:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds AI-powered translation capabilities for the FastAPI-fastkit documentation, enabling automated translation to multiple languages (Korean, Japanese, Chinese, Spanish, French, and German) using OpenAI and Anthropic APIs.

Key Changes:

  • Implements automated documentation translation system with AI API support
  • Adds i18n structure setup for multi-language documentation
  • Updates CLI to use non-deprecated Click API (Command instead of BaseCommand)

Reviewed Changes

Copilot reviewed 35 out of 66 changed files in this pull request and generated no comments.

Show a summary per file
File Description
scripts/translate.py Core translation script with AI API integration and GitHub PR automation
scripts/update_nav_translations.py Utility to update navigation translations in mkdocs.yml
scripts/translation_config.json Configuration file for translation settings and supported languages
scripts/setup-i18n-structure.sh Shell script to migrate docs to language-specific directories
docs/en/contributing/translation-guide.md Comprehensive guide for contributing translations
.github/workflows/translate-docs.yml GitHub Actions workflow for automated translation
mkdocs.yml i18n plugin configuration with navigation translations
pyproject.toml Added translation and docs dependencies
src/fastapi_fastkit/cli.py Updated to use Command instead of deprecated BaseCommand
tests/test_cli_operations/test_cli.py Enhanced test assertions and debugging for runserver command
CONTRIBUTING.md Added translation contribution guidelines
env.example Template for translation API keys
docs/{lang}/css, docs/{lang}/js, docs/{lang}/img Symbolic links to shared assets
Comments suppressed due to low confidence (5)

pyproject.toml:1

  • The version constraint '>=1.3.0' may reference a non-existent version of mkdocs-static-i18n. As of January 2025, the latest stable version was around 1.2.x. Verify this version exists or adjust to a known stable version like '>=1.2.0'.
    pyproject.toml:1
  • The version '>=2.8.1' appears to be ahead of the OpenAI Python library versions available as of January 2025 (latest was around 1.x). Verify this version exists or use a constraint like '>=1.0.0'.
    pyproject.toml:1
  • The version '>=0.74.0' may not exist for the anthropic library as of January 2025. Verify the actual available versions and adjust the constraint accordingly.
    pyproject.toml:1
  • The version '6.0.12.20250915' contains a datestamp (20250915 = September 15, 2025) that is in the future relative to the current date (November 2025 stated in context, but this still seems incorrect). Verify the actual version or use a more recent valid version number.
    scripts/translate.py:1
  • The docs_dir default value references source_lang before it's defined in the dataclass field order. This will raise a NameError. Move source_lang field before docs_dir or use a default_factory with proper field reference.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bnbong bnbong merged commit 560a458 into main Nov 20, 2025
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request template Add or editing a FastAPI template

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documents translation

2 participants