diff --git a/README.md b/README.md index f8d6528..cb9c45b 100644 --- a/README.md +++ b/README.md @@ -103,9 +103,11 @@ Install and configure it as follows: - Add `WAGTAIL_TRANSLATE_DEEPL_KEY = "..."` to your settings. - Set `WAGTAIL_TRANSLATE_TRANSLATOR = "wagtail_translate.translators.deepl.DeepLTranslator"` -## Customise Wagtail Translate +## Documentation -See: [docs/customise_wagtail_translate.md](https://github.com/allcaps/wagtail-translate/tree/main/docs/customise_wagtail_translate.md). +- This readme for installation and basic usage. +- [How to customise Wagtail Translate](https://github.com/allcaps/wagtail-translate/tree/main/docs/customise_wagtail_translate.md) +- [Explanation](https://github.com/allcaps/wagtail-translate/tree/main/docs/explanation.md) ## Contributing diff --git a/docs/explanation.md b/docs/explanation.md index 1f8e7b8..272e657 100644 --- a/docs/explanation.md +++ b/docs/explanation.md @@ -1,6 +1,6 @@ # Explanation -This document outlines the concepts behind Wagtail Translate and explains the motivations for its design choices. +This document details the concepts underlying Wagtail Translate and explains the reasoning behind its design choices. It aims to enhance and expand your understanding of Wagtail Translation. ## Idea and positioning @@ -32,8 +32,6 @@ Wagtail Translate is designed to be flexible, allowing you to tailor its behavio - Define your own signal handler - Customize the translation process -See the [Customization](customization.md) document for more information. - ## Background workers Wagtail Translate uses external services like DeepL to provide translations. These services can take time, fail to respond, or be offline. @@ -42,8 +40,6 @@ By default, Wagtail Translate handles translations synchronously, meaning they b Django's [background workers](https://www.djangoproject.com/weblog/2024/may/29/django-enhancement-proposal-14-background-workers/) are an accepted proposal and are in development. Once available, they will offer a unified way to offload tasks. Wagtail Translate is expected to support them. For now, if you need translations offloaded to a background task, you can customize the default behaviors and implement this yourself. -See the [Customization](customization.md) document for more information. - ## Fields to translate Wagtail Translate introspects the model definition to identify the fields that need translation. You can control which fields are translated by implementing a `get_translatable_fields` method on your model. @@ -83,5 +79,3 @@ This approach prevents deep traversal as related objects can have related object Since Wagtail Translate can't forsee the intended behaviour, it uses the simplest approach: use if the translation exists, otherwise use the original object. This means that sometimes the content editor needs to step in and translate the related object, and select that related object. To adjust this behaviour, override `BaseTranslator.translate_related_object`. - -See the [Customization](customization.md) document for more information.