diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2021-09-29 21:12:14 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2021-09-29 21:13:08 -0400 |
| commit | e4089e846e7cc2941e3eae14855ab5f39ef3906c (patch) | |
| tree | 03980b6fa026b7745ca29e3a0f8e3630c9fa098a /docs | |
| parent | b3b597a215b9bf12233c473006e91c00ab533353 (diff) | |
| download | kutter-e4089e846e7cc2941e3eae14855ab5f39ef3906c.tar.gz kutter-e4089e846e7cc2941e3eae14855ab5f39ef3906c.tar.xz kutter-e4089e846e7cc2941e3eae14855ab5f39ef3906c.zip | |
docs: Update CONTRIBUTING.md with new repo location; minor wording changes
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/CONTRIBUTING.md | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 518e8cc1..107797ca 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -37,7 +37,7 @@ contributions) and contain a current email address. ## Contributing to Klipper Translations -[Klipper-translations Project](https://github.com/KevinOConnor/klipper-translations) +[Klipper-translations Project](https://github.com/Klipper3d/klipper-translations) is a project dedicated to translating Klipper to different languages. [Weblate](https://hosted.weblate.org/projects/klipper/) hosts all the Gettext strings for translating and reviewing. Locales can merge into @@ -45,19 +45,20 @@ the Klipper project once they satisfy the following requirements: - [ ] 75% Total coverage - [ ] All titles (H1) are covered -- [ ] An updated navigation hierarchy PR into klipper-translations. +- [ ] An updated navigation hierarchy PR in klipper-translations. The navigation hierarchy is in `docs\_klipper3d\mkdocs.yml`. -To reduce the frustration of translating domain-specific terms -and gain awareness of the ongoing translations, you can submit a PR -modifying the [Klipper-translations Project](https://github.com/KevinOConnor/klipper-translations) -'s `readme.md`. Once a translation is ready, we can pull the -corresponding modification into the Klipper project with some changes. +To reduce the frustration of translating domain-specific terms and +gain awareness of the ongoing translations, you can submit a PR +modifying the +[Klipper-translations Project](https://github.com/Klipper3d/klipper-translations) +`readme.md`. Once a translation is ready, the corresponding +modification to the Klipper project can be made. If a translation already exists in the Klipper repository and no -longer meets the checklist above, we will mark it out-of-date -after a month without updating. +longer meets the checklist above, it will be marked out-of-date after +a month without updates. Please follow the following format for `mkdocs.yml` navigation hierarchy: @@ -69,5 +70,5 @@ nav: - locales/<language code>/md file ``` -Note: Currently, there isn't a method for correctly displaying -photos in the translated documents. +Note: Currently, there isn't a method for correctly translating +pictures in the documentation. |