makiolaj
e870918a03
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.
32 lines
1.7 KiB
Markdown
32 lines
1.7 KiB
Markdown
# Clockula — documentation
|
||
|
||
Clockula is a Material 3 Expressive **clock** app for Android: alarms, timers,
|
||
stopwatch and world clock. Third floret of the bloom, after
|
||
[Calendula](https://codeberg.org/jlmakiola/calendula) (calendar) and
|
||
[Agendula](https://codeberg.org/jlmakiola/agendula) (tasks). See the top-level
|
||
[`../README.md`](../README.md) for the pitch.
|
||
|
||
Unlike its siblings, Clockula owns its storage, because there is no open provider behind
|
||
a clock. What that costs and how the open-standards commitment is honoured anyway
|
||
is the first section of [`PLAN.md`](PLAN.md).
|
||
|
||
## Index
|
||
|
||
| Doc | What it covers |
|
||
|---|---|
|
||
| [`PLAN.md`](PLAN.md) | **The spec.** Thesis, locked decisions, the alarm engine, data model, system interop, identity, pipeline, and how ClockMaster is used. The "why". |
|
||
| [`ROADMAP.md`](ROADMAP.md) | **Status and the work queue**: milestones M0–M11 and post-v1. What the build loop works through. |
|
||
| [`ARCHITECTURE.md`](ARCHITECTURE.md) | How Clockula is built **today**: layers, the data seam, the alarm engine, DI, build/tooling, manifest. Written from M2 onward. |
|
||
| [`RELEASING.md`](RELEASING.md) | How to cut a release. Written at M0 alongside the pipeline. |
|
||
| [`PROVENANCE.md`](PROVENANCE.md) | Any third-party code carried in-tree and under what licence. Created only if we actually lift something (`PLAN.md` §11). |
|
||
|
||
Also: [`../CHANGELOG.md`](../CHANGELOG.md) (Keep a Changelog format; tag sections
|
||
feed the release notes).
|
||
|
||
## How the docs relate
|
||
|
||
- **PLAN** is the design decisions (stable; the "why").
|
||
- **ARCHITECTURE** is the current shape of the code (kept in sync as it grows).
|
||
- **ROADMAP** is the moving status layer (updated as milestones land).
|
||
- **RELEASING** is the operational runbook.
|