Weblate 문서에 기여하기

원하는 문서 페이지를 자유롭게 개선할 수 있습니다. 페이지 오른쪽 상단의 Edit on GitHub 버튼을 클릭하면 쉽게 할 수 있습니다.

문서 지침

작성 시 다음 지침을 준수하세요:

  1. 유효한 문서의 일부를 제거하지 마세요.

  2. 명확하고 이해하기 쉬운 언어를 사용하세요. 기술 문서를 작성하는 것이지 시를 쓰는 것이 아닙니다. 모든 문서 독자가 원어민은 아니므로 배려하세요.

  3. 확실하지 않다면 주저하지 말고 물어보세요. 편집하는 동안 어떤 기능에 대해 물어봐야 하는 경우 답을 얻기 전에 문서를 변경하지 마세요. 즉 변경하거나 물어보세요. 두 가지를 동시에 하지 마세요.

  4. 문서를 따라 설명된 작업을 수행하여 변경 사항을 확인하세요.

  5. 검토와 병합을 더 쉽고 빠르게 하려면 작은 단위로 변경 사항을 PR로 보내세요.

  6. 큰 문서를 다시 작성하고 구조를 변경하려면 두 단계로 진행하세요:

    1. 다시 작성

    2. 다시 작성한 내용이 검토, 다듬어지고 병합되면 다른 PR에서 단락의 구조를 변경하세요.

문서를 로컬에서 빌드하기

문서를 로컬에서 편집하고 빌드할 수도 있습니다. Python 요구 사항은 pyproject.toml 의 docs 의존성 그룹에 있습니다. 이미 전체 개발 환경을 사용하고 있다면 uv sync --all-extras --dev 로 충분합니다. 문서 작업만 위해서는 uv sync --group docs 로 충분합니다.

권장되는 로컬 워크플로:

make -C docs update-docs
./ci/run-docs

ci/run-docs 래퍼는 경고를 오류로 처리하여 문서를 빌드합니다.

힌트

문서를 빌드하려면 graphviz 도 설치해야 합니다.

문서 번역

문서를 번역 할 수 있습니다.

생성된 문서 스니펫 업데이트

여러 문서 섹션에서 코드에서 생성된 템플릿을 사용합니다. 이를 새로 고치는 권장 방법:

make -C docs update-docs

이 타겟은 문서에서 현재 사용되는 스니펫을 다시 생성하며, 다음을 포함함:

  • 애드온 이벤트, 내장 애드온 및 일반 애드온 매개변수

  • 기계 번역 서비스

  • 파일 형식 매개변수 및 파일 형식 기능 테이블

  • 권한 및 내장 역할

  • 검사 및 검사 플래그

수동으로 유지되는 텍스트는 자동 생성 스니펫에 추가하지 말고 상위 문서 페이지에 유지하세요. 예를 들어 애드온 에는 이벤트, 내장 애드온 및 일반 애드온 매개변수에 대한 세 개의 생성 파일이 포함되어 있으며, 더 이상 사용되지 않는 애드온은 페이지에서 직접 관리됩니다.

한 부분만 다시 생성해야 하는 경우 개별 관리 명령은 관리 명령어 에 문서화되어 있으며 update-docs 에서 사용하는 정확한 명령은 docs/Makefile 에 나열되어 있습니다.