docs: improve RST consistency, update translations, and add gap analysis tooling#165
Open
docs: improve RST consistency, update translations, and add gap analysis tooling#165
Conversation
- Standardize headings, terminology, and voice across RST files - Update ko/th/ja PO translations for untranslated/fuzzy entries - Improve translate_po.py script with better error handling - Add pyyaml dependency to pyproject.toml Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add docs-mapping.yml for React source to RST file mapping - Add GitHub Actions workflows for auto Draft PR, translation sync, and mapping drift check - Add analysis scripts: analyze_changes, analyze_docs_gap, check_mapping_drift, generate_pr_summary - Add CLAUDE.md and STYLE_GUIDE.md for documentation guidelines - Add PAT_SETUP.md for cross-repo authentication guide - Update .gitignore to exclude generated reports Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove CI workflows and scripts that were planned for cross-repo automation (docs-auto-update, translation sync, drift check). This repo may become obsolete, so the automation infra is no longer needed. Keep only the doc content fixes, gap analysis tool, and style guides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
lizable
changed the title
Convert style guide from RST conventions to Markdown in preparation for the docs format migration. Adds sections for code blocks, tables, and GitHub-style alerts. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
RST 문서 일관성 개선, 번역 업데이트, 그리고 gap 분석/번역 도구를 추가합니다.
이번 PR에서 수정한 것
RST 일관성 개선 (14개 파일)
Control Panel→WebUI,Image→Environment등번역 업데이트 (37개 PO 파일)
도구 & 가이드
scripts/analyze_docs_gap.py— webui 릴리즈 간 문서 gap 분석 도구 (--format text|json|markdown|summary)translate_po.py— PO 파일 번역 스크립트 개선CLAUDE.md— Claude Code CLI 작업 가이드STYLE_GUIDE.md— RST 문서 스타일 규칙아직 업데이트가 필요한 문서 (v25.15 → v26.1 gap)
scripts/analyze_docs_gap.py --format summary로 분석한 결과입니다.우선순위별 업데이트 대상 (상위 5개)
Priority 1: sessions_all.rst (23 features)
Priority 2: session_page.rst (21 features)
Priority 3: admin_menu.rst (15 features)
Priority 4: header.rst (14 features)
Priority 5: mount_vfolder.rst / share_vfolder.rst / vfolder.rst (9 features each)
No RST Mapping (8 features)
Internal Changes (8) — No doc update needed
Review Checklist
make html빌드 확인Auto-generated gap analysis by
scripts/analyze_docs_gap.py