Jean-Luc Makiola
03cb767f72
ROADMAP.md and STATE.md predate the issue tracker. They were how planning worked before issues and milestones existed, and keeping them means maintaining a second copy of that information by hand — which is why STATE.md still described release/v2.8.0 as the next release, eight minors ago. Issues and milestones say the same thing and can't drift: a milestone maps to its release/vX.Y.Z branch, which is now also how a contributor learns where to target a PR. Both files stay in git history if a past decision needs looking up. Repointed the six references at the tracker: the README's docs list, two rows in the docs map, PROJECT.md's Current Milestone, and REQUIREMENTS.md's idea-backlog pointer. ARCHITECTURE.md's "see the roadmap's idea backlog" now cites the crash reporter's web-issue path instead — a worked example of the no-network rule beats a pointer to a deleted backlog.
2.4 KiB
2.4 KiB
Documentation map
Where to look for what:
| Document | What it is |
|---|---|
../CONTRIBUTING.md |
How to contribute: issue-first workflow, which branch to target, translations, the rules a change is reviewed against |
BUILDING.md |
Building from source: submodule, JDK/SDK requirements, Gradle tasks, what CI runs |
ARCHITECTURE.md |
Orientation tour: principles, layers, navigation, recurring-write / conflict / reminder pipelines, testing |
RELEASING.md |
Release process: versioning, the merge-driven pipeline, the two-forge split, secrets, key custody |
../CHANGELOG.md |
Release history (Keep a Changelog, SemVer) |
| Issues + milestones | The roadmap. What's planned, in progress, and shipped — a milestone maps to its release/vX.Y.Z branch |
../.planning/PROJECT.md |
What the project is, stack, naming, infrastructure |
../.planning/REQUIREMENTS.md |
Historical V1/V2 requirement checklist, plus the stack/platform constraints |
design/ |
Per-feature design notes kept for features whose provider behaviour is worth recording |
../fastlane/metadata/android/ |
Store metadata (single source of truth): descriptions, title, icon, screenshots (DE + EN). Harvested directly by the official F-Droid repo; transformed into the self-hosted repo layout at release time by ../scripts/fastlane_to_fdroid_localized.sh |
../fdroid-metadata/ |
App-level F-Droid control file (*.yml: Categories, License, links) for the self-hosted repo's fdroid update |
fdroid-official/ |
Recipe + notes for publishing to the official F-Droid repo (reproducible build + developer-signed binary) |
Conventions: planning lives in the issue tracker, not in this repository. The
.planning/ files that predated it (a roadmap and a development-state snapshot)
are gone — issues and milestones say the same thing without going stale.
ARCHITECTURE.md is the authoritative orientation tour: it is updated with the
code, and is the right place for a lesson learned about the calendar provider.