Problem
The README was missing sections on WEBLATE_ADD_APPS, HTTP routes, and the Celery task, leaving operators without guidance on app registration, URL setup, and async execution.
Acceptance Criteria
Implementation Notes
WEBLATE_ADD_APPS and settings_override.py must not both be used — doing so duplicates the app in INSTALLED_APPS and raises ImproperlyConfigured at startup.
- Routes are not auto-discovered from
INSTALLED_APPS; BoostEndpointConfig.ready() appends to weblate.urls.real_patterns explicitly.
- Celery task passes
user_id (not User) because arguments are JSON-serialized; trail=False prevents unbounded result-backend growth.
References
Problem
The README was missing sections on
WEBLATE_ADD_APPS, HTTP routes, and the Celery task, leaving operators without guidance on app registration, URL setup, and async execution.Acceptance Criteria
endpoint/and showsAppConfig.ready()→real_patterns.WEBLATE_ADD_APPSsection explains the env var, compares it tosettings_override.py, and warns against using both.Routessection lists all three endpoints and explains why explicitreal_patternsmutation is required.Celery tasksection covers the request→dispatch→worker flow, task signature, andBoostComponentServicesteps.Implementation Notes
WEBLATE_ADD_APPSandsettings_override.pymust not both be used — doing so duplicates the app inINSTALLED_APPSand raisesImproperlyConfiguredat startup.INSTALLED_APPS;BoostEndpointConfig.ready()appends toweblate.urls.real_patternsexplicitly.user_id(notUser) because arguments are JSON-serialized;trail=Falseprevents unbounded result-backend growth.References
README.md