thaloco/aman
1
Fork 0
Code Pull requests Releases Packages Activity Actions
aman/docs/x11-ga/01-support-contract-and-ga-bar.md
Thales Maciel 01a580f359
Add X11 GA roadmap and milestone definitions 
Capture the current GA gaps and define a portable X11 support contract so the release bar is explicit for mainstream distros.

Document five ordered milestones covering support policy, portable install/update/uninstall, runtime reliability and diagnostics, first-run UX/docs, and GA validation/release evidence.

Left generated artifacts (src/aman.egg-info) and prior readiness notes uncommitted.
2026-03-12 13:56:41 -03:00

2.7 KiB
Raw Blame History

Milestone 1: Support Contract and GA Bar

Why this milestone exists

The current project already has strong building blocks, but the public promise is still underspecified. Before adding more delivery or UX work, Aman needs a written support contract that tells users and implementers exactly what "GA for X11 users on any distro" means.

Problems it closes

  • The current docs do not define a precise supported environment.
  • The default user lifecycle is ambiguous between a user service and foreground aman run.
  • "Any distro" is too vague to test or support responsibly.
  • The project lacks one GA checklist that later work can trace back to.

In scope

  • Define the supported X11 environment for GA.
  • Define the representative distro validation families.
  • Define the canonical end-user lifecycle: install, first launch, daily use, update, uninstall.
  • Define the role of service mode versus foreground/manual mode.
  • Define the canonical recovery sequence using diagnostics and logs.
  • Define the final GA signoff checklist that the release milestone will complete.

Out of scope

  • Implementing the portable installer.
  • Changing GUI behavior.
  • Adding Wayland support.
  • Adding new AI or STT capabilities that do not change supportability.

Dependencies

  • Current README and persona docs.
  • Existing systemd user service behavior.
  • Existing doctor, self-check, and verbose foreground run support.

Definition of done: objective

  • A public support matrix names Debian/Ubuntu, Arch, Fedora, and openSUSE as the representative GA distro families.
  • The supported session assumptions are explicit: X11, systemd --user, and python3 3.10+ available for installer execution.
  • The canonical end-user lifecycle is documented end to end.
  • Service mode is defined as the default daily-use path.
  • Foreground aman run is explicitly documented as a support/debug path.
  • aman doctor, aman self-check, and journalctl --user -u aman are defined as the canonical recovery sequence.
  • A GA checklist exists and every later milestone maps back to at least one item on it.

Definition of done: subjective

  • A new X11 user can quickly tell whether Aman supports their machine.
  • An implementer can move to later milestones without reopening the product promise.
  • The project no longer sounds broader than what it is prepared to support.

Evidence required to close

  • Updated README support section that matches the contract in this roadmap.
  • A published support matrix doc or README table for environment assumptions and distro families.
  • An updated release checklist that includes the GA signoff checklist.
  • CLI help and support docs that use the same language for service mode, manual mode, and diagnostics.