Define the X11 support contract for milestone 1
Clarify the current release channels versus the X11 GA target so the project has an explicit support promise before milestone 2 delivery work begins. Update the README, persona and distribution docs, and release checklist with a support matrix, the systemd --user daily-use path, the manual aman run support path, and the canonical recovery sequence. Mark milestone 1 complete in the roadmap once that contract is documented. Align run, doctor, and self-check help text with the same service and diagnostics language without changing command behavior. Validated with PYTHONPATH=src python3 -m aman --help, PYTHONPATH=src python3 -m aman doctor --help, and PYTHONPATH=src python3 -m aman self-check --help. Excludes generated src/aman.egg-info and prior user-readiness notes.
This commit is contained in:
parent
01a580f359
commit
9ccf73cff5
5 changed files with 149 additions and 38 deletions
|
|
@ -4,16 +4,21 @@
|
|||
|
||||
This is the canonical Aman user.
|
||||
|
||||
- Uses Linux desktop daily (X11 today), mostly Ubuntu/Debian.
|
||||
- Uses Linux desktop daily on X11, across mainstream distros.
|
||||
- Wants fast dictation and rewriting without learning Python tooling.
|
||||
- Prefers GUI setup and tray usage over CLI.
|
||||
- Expects normal install/uninstall/update behavior from system packages.
|
||||
- Expects a simple end-user install plus a normal background service lifecycle.
|
||||
|
||||
Design implications:
|
||||
|
||||
- End-user install path must not require `uv`.
|
||||
- Runtime defaults should work with minimal input.
|
||||
- Documentation should prioritize package install first.
|
||||
- Supported daily use should be a `systemd --user` service.
|
||||
- Foreground `aman run` should remain available for setup, support, and
|
||||
debugging.
|
||||
- Diagnostics should be part of the user workflow, not only developer tooling.
|
||||
- Documentation should distinguish current release channels from the long-term
|
||||
GA contract.
|
||||
|
||||
## Secondary Persona: Power User
|
||||
|
||||
|
|
@ -27,24 +32,52 @@ Design implications:
|
|||
- Keep explicit expert-mode knobs in settings and config.
|
||||
- Keep docs for development separate from standard install docs.
|
||||
|
||||
## Supported Distribution Path (Current)
|
||||
## Current Release Channels
|
||||
|
||||
Tiered distribution model:
|
||||
The current release channels are:
|
||||
|
||||
1. Canonical: Debian package (`.deb`) for Ubuntu/Debian users.
|
||||
1. Current end-user channel: Debian package (`.deb`) for Ubuntu/Debian users.
|
||||
2. Secondary: Arch package inputs (`PKGBUILD` + source tarball).
|
||||
3. Developer: wheel/sdist from `python -m build`.
|
||||
3. Developer: wheel and sdist from `python -m build`.
|
||||
|
||||
## Out of Scope for Initial Packaging
|
||||
The portable X11 installer is the GA target channel, not the current shipped
|
||||
channel.
|
||||
|
||||
## GA Target Support Contract
|
||||
|
||||
For X11 GA, Aman supports:
|
||||
|
||||
- X11 desktop sessions only.
|
||||
- Runtime dependencies installed from the distro package manager.
|
||||
- `systemd --user` as the supported daily-use path.
|
||||
- `aman run` as the foreground setup, support, and debugging path.
|
||||
- Representative validation across Debian/Ubuntu, Arch, Fedora, and openSUSE.
|
||||
- The recovery sequence `aman doctor` -> `aman self-check` ->
|
||||
`journalctl --user -u aman` -> `aman run --verbose`.
|
||||
|
||||
"Any distro" means mainstream distros that satisfy these assumptions. It does
|
||||
not mean native-package parity or exhaustive certification for every Linux
|
||||
variant.
|
||||
|
||||
## Out of Scope for X11 GA
|
||||
|
||||
- Wayland production support.
|
||||
- Flatpak/snap-first distribution.
|
||||
- Cross-platform desktop installers outside Linux.
|
||||
- Native-package parity across every distro.
|
||||
|
||||
## Release and Support Policy
|
||||
|
||||
- App versioning follows SemVer (`0.y.z` until API/UX stabilizes).
|
||||
- Config schema versioning is independent (`config_version` in config).
|
||||
- Packaging docs must always separate:
|
||||
- End-user install path (package-first)
|
||||
- Developer setup path (uv/pip/build workflows)
|
||||
- Docs must always separate:
|
||||
- Current release channels
|
||||
- GA target support contract
|
||||
- Developer setup paths
|
||||
- The public support contract must always identify:
|
||||
- Supported environment assumptions
|
||||
- Daily-use service mode versus manual foreground mode
|
||||
- Canonical recovery sequence
|
||||
- Representative validation families
|
||||
- GA means the support contract, validation evidence, and release surface are
|
||||
consistent. It does not require a native package for every distro.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
# Release Checklist
|
||||
|
||||
This checklist covers both current releases and the future X11 GA bar. The GA
|
||||
signoff sections are required for `v1.0.0` and later.
|
||||
|
||||
1. Update `CHANGELOG.md` with final release notes.
|
||||
2. Bump `project.version` in `pyproject.toml`.
|
||||
3. Run quality and build gates:
|
||||
|
|
@ -20,3 +23,13 @@
|
|||
- `git tag vX.Y.Z`
|
||||
- `git push origin vX.Y.Z`
|
||||
8. Publish release and upload package artifacts from `dist/`.
|
||||
9. GA support-contract signoff (`v1.0.0` and later):
|
||||
- `README.md` and `docs/persona-and-distribution.md` agree on supported environment assumptions.
|
||||
- The support matrix names X11, runtime dependency ownership, `systemd --user`, and the representative distro families.
|
||||
- Service mode is documented as the default daily-use path and `aman run` as the manual support/debug path.
|
||||
- The recovery sequence `aman doctor` -> `aman self-check` -> `journalctl --user -u aman` -> `aman run --verbose` is documented consistently.
|
||||
10. GA validation signoff (`v1.0.0` and later):
|
||||
- Validation evidence exists for Debian/Ubuntu, Arch, Fedora, and openSUSE.
|
||||
- The portable installer, upgrade path, and uninstall path are validated.
|
||||
- End-user docs and release notes match the shipped artifact set.
|
||||
- Public metadata, checksums, and support/reporting surfaces are complete.
|
||||
|
|
|
|||
|
|
@ -80,16 +80,20 @@ Any future docs, tray copy, and release notes should point users to this same se
|
|||
|
||||
## Milestones
|
||||
|
||||
1. [Milestone 1: Support Contract and GA Bar](./01-support-contract-and-ga-bar.md)
|
||||
Lock the public promise, supported environment, and final signoff bar.
|
||||
2. [Milestone 2: Portable Install, Update, and Uninstall](./02-portable-install-update-uninstall.md)
|
||||
Build one reliable end-user lifecycle that works across mainstream X11 distros.
|
||||
3. [Milestone 3: Runtime Reliability and Diagnostics](./03-runtime-reliability-and-diagnostics.md)
|
||||
Make startup, failure handling, and recovery predictable.
|
||||
4. [Milestone 4: First-Run UX and Support Docs](./04-first-run-ux-and-support-docs.md)
|
||||
Turn the product from "documented by the author" into "understandable by a new user."
|
||||
5. [Milestone 5: GA Candidate Validation and Release](./05-ga-candidate-validation-and-release.md)
|
||||
Close the remaining trust, legal, release, and validation work for a public 1.0 launch.
|
||||
- [x] [Milestone 1: Support Contract and GA Bar](./01-support-contract-and-ga-bar.md)
|
||||
Status: completed on 2026-03-12. Evidence: `README.md` now defines the
|
||||
support matrix, daily-use versus manual mode, and recovery sequence;
|
||||
`docs/persona-and-distribution.md` now separates current release channels from
|
||||
the GA contract; `docs/release-checklist.md` now includes GA signoff gates;
|
||||
CLI help text now matches the same service/support language.
|
||||
- [ ] [Milestone 2: Portable Install, Update, and Uninstall](./02-portable-install-update-uninstall.md)
|
||||
Build one reliable end-user lifecycle that works across mainstream X11 distros.
|
||||
- [ ] [Milestone 3: Runtime Reliability and Diagnostics](./03-runtime-reliability-and-diagnostics.md)
|
||||
Make startup, failure handling, and recovery predictable.
|
||||
- [ ] [Milestone 4: First-Run UX and Support Docs](./04-first-run-ux-and-support-docs.md)
|
||||
Turn the product from "documented by the author" into "understandable by a new user."
|
||||
- [ ] [Milestone 5: GA Candidate Validation and Release](./05-ga-candidate-validation-and-release.md)
|
||||
Close the remaining trust, legal, release, and validation work for a public 1.0 launch.
|
||||
|
||||
## Cross-milestone acceptance scenarios
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue