From e870918a03cef099cd9c51bac9951bc7e6dd0de0 Mon Sep 17 00:00:00 2001 From: Jean-Luc Makiola Date: Tue, 6 Oct 2026 19:14:11 +0200 Subject: [PATCH] docs: plain-language pass over every doc Removes AI-writing patterns across the docs, store listing and templates: dash-heavy rhythm, not-X-but-Y contrasts, one-line kickers and decorative bold. Facts, code, links and headings are unchanged. Also fixes leftovers copied from the sibling apps: the crash report template promised "no calendar content", and CONTRIBUTING described Agendula's task-provider layout, test seams and commit style. --- .forgejo/ISSUE_TEMPLATE/config.yml | 15 +- .forgejo/ISSUE_TEMPLATE/crash_report.md | 8 +- .forgejo/ISSUE_TEMPLATE/feature_request.md | 2 +- .forgejo/PULL_REQUEST_TEMPLATE.md | 6 +- CONTRIBUTING.md | 51 +- docs/ARCHITECTURE.md | 788 +++++++++--------- docs/BACKUP.md | 28 +- docs/PLAN.md | 68 +- docs/README.md | 8 +- docs/ROADMAP.md | 414 ++++----- .../android/en-US/full_description.txt | 6 +- 11 files changed, 697 insertions(+), 697 deletions(-) diff --git a/.forgejo/ISSUE_TEMPLATE/config.yml b/.forgejo/ISSUE_TEMPLATE/config.yml index 05abff8..46d414f 100644 --- a/.forgejo/ISSUE_TEMPLATE/config.yml +++ b/.forgejo/ISSUE_TEMPLATE/config.yml @@ -6,8 +6,8 @@ contact_links: - name: Translate Clockula url: https://weblate.dev.jeanlucmakiola.de/engage/clockula/ about: >- - Translations are managed on Weblate, not here — it owns every values-* - file, so a hand-edited translation gets overwritten on the next sync. + Translations are managed on Weblate, which owns every values-* file, so + a translation edited by hand here gets overwritten on the next sync. No coding needed: pick or request a language and translate in the browser. - name: Contributing guide @@ -20,13 +20,12 @@ contact_links: url: https://codeberg.org/jlmakiola/clockula/src/branch/main/README.md about: >- Open the app's own self-check first (Settings → Why might my alarm not - ring?). It reports what your device is actually doing — battery - optimisation, notification and full-screen-intent permissions, the next - alarm as the system sees it — and that report is what makes such an issue - actionable. + ring?). It reports what your device is doing (battery optimisation, + notification and full-screen-intent permissions, the next alarm as the + system sees it). Include that report so the issue can be acted on. - name: Scope and roadmap url: https://codeberg.org/jlmakiola/clockula/src/branch/main/docs/ROADMAP.md about: >- - What's built, what's planned, and what's deliberately out of scope — - check here before requesting a feature. + What's built, what's planned, and what's deliberately out of scope. + Check here before requesting a feature. diff --git a/.forgejo/ISSUE_TEMPLATE/crash_report.md b/.forgejo/ISSUE_TEMPLATE/crash_report.md index 6acf2ce..d478d19 100644 --- a/.forgejo/ISSUE_TEMPLATE/crash_report.md +++ b/.forgejo/ISSUE_TEMPLATE/crash_report.md @@ -1,6 +1,6 @@ --- name: Crash report -about: Report a crash. Clockula can capture this for you (Settings → Report a problem, or the prompt after a crash) — it copies the report to your clipboard and prefills this form. +about: Report a crash. Clockula can capture this for you (Settings → Report a problem, or the prompt after a crash). It copies the report to your clipboard and prefills this form. title: "Crash: " labels: - bug @@ -11,10 +11,10 @@ labels: ### What happened diff --git a/.forgejo/ISSUE_TEMPLATE/feature_request.md b/.forgejo/ISSUE_TEMPLATE/feature_request.md index 588fccc..f0b0d63 100644 --- a/.forgejo/ISSUE_TEMPLATE/feature_request.md +++ b/.forgejo/ISSUE_TEMPLATE/feature_request.md @@ -9,7 +9,7 @@ labels: ### What would you like Clockula to do? -### Why — what problem does it solve? +### What problem would it solve? ### Anything else diff --git a/.forgejo/PULL_REQUEST_TEMPLATE.md b/.forgejo/PULL_REQUEST_TEMPLATE.md index 79959c1..08c427e 100644 --- a/.forgejo/PULL_REQUEST_TEMPLATE.md +++ b/.forgejo/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ Please skim CONTRIBUTING.md if you haven't: https://codeberg.org/jlmakiola/clockula/src/branch/main/CONTRIBUTING.md Two things it's easy to get wrong: - • The one architectural rule — Room entities, DAOs and `@Query` strings never + • The one architectural rule: Room entities, DAOs and `@Query` strings never leak above the data layer. Everything else talks to a repository. • Don't bump `versionName` / `versionCode`. That bump reaching `main` is what cuts a release, so it belongs only in a release PR. @@ -16,7 +16,7 @@ Two things it's easy to get wrong: ### Why - + ### How it was tested @@ -24,7 +24,7 @@ Two things it's easy to get wrong: