Skip to content

docs: simplify README and automate Korean localization - #8

Merged
Kinirin merged 6 commits into
mainfrom
docs/readme-localization-automation
Aug 9, 2026
Merged

docs: simplify README and automate Korean localization#8
Kinirin merged 6 commits into
mainfrom
docs/readme-localization-automation

Conversation

@Kinirin

@Kinirin Kinirin commented Aug 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • simplify README.md into a version-independent project overview
  • use pip install ptsip for latest published installation and document minimum-compatible dependency constraints
  • keep English/Korean navigation in both READMEs
  • make README.md the canonical source and mark README.ko.md as generated
  • add GitHub Models based translation automation using the repository GITHUB_TOKEN
  • add reusable structural validation for headings, fenced code blocks, links, normative keywords, and suspicious output length

Automation design

  • triggers only when README.md changes on main, plus manual workflow dispatch
  • uses models: read and contents: write; no separate model API secret
  • commits only README.ko.md when translation actually changes
  • bot pushes use GITHUB_TOKEN, avoiding recursive push-triggered workflow runs

Validation

  • branch is based on current main SHA 6db3a37c0ee6ba8c55b2facfff699a3cafea2573
  • translation helper compiles successfully with Python
  • workflow YAML parses successfully
  • compare against main contains only README localization/automation files

@Kinirin
Kinirin merged commit e8a2768 into main Aug 9, 2026
8 checks passed
@Kinirin
Kinirin deleted the docs/readme-localization-automation branch August 9, 2026 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant