aman/SUPPORT.md
Thales Maciel 31a1e069b3
Prepare the 1.0.0 GA release surface
Add the repo-side pieces for milestone 5: MIT licensing, real maintainer and forge metadata, a public support doc, 1.0.0 release notes, release-prep tooling, and CI uploads for the full candidate artifact set.

Keep source-tree version surfaces honest by reading the local project version in the CLI and About dialog, and cover the new release-prep plus version-fallback behavior with focused tests.

Document where raw validation evidence belongs, add the GA validation rollup, and archive the latest readiness review. Milestone 5 remains open until the forge release page is published and the milestone 2 and 3 matrices are filled with linked manual evidence.

Validation: PYTHONPATH=src python3 -m unittest discover -s tests -p 'test_*.py'; PYTHONPATH=src python3 -m unittest tests.test_release_prep tests.test_portable_bundle tests.test_aman_cli tests.test_config_ui; python3 -m py_compile src/*.py tests/*.py; PYTHONPATH=src python3 -m aman version
2026-03-12 19:36:52 -03:00

35 lines
1.2 KiB
Markdown

# Support
Aman supports X11 desktop sessions on mainstream Linux distros with the
documented runtime dependencies and `systemd --user`.
For support, bug reports, or packaging issues, email:
- `thales@thalesmaciel.com`
## Include this information
To make support requests actionable, include:
- distro and version
- whether the session is X11
- how Aman was installed: portable bundle, `.deb`, Arch package inputs, or
developer install
- the Aman version you installed
- the output of `aman doctor --config ~/.config/aman/config.json`
- the output of `aman self-check --config ~/.config/aman/config.json`
- the first relevant lines from `journalctl --user -u aman`
- whether the problem still reproduces with
`aman run --config ~/.config/aman/config.json --verbose`
## Supported escalation path
Use the supported recovery order before emailing:
1. `aman doctor --config ~/.config/aman/config.json`
2. `aman self-check --config ~/.config/aman/config.json`
3. `journalctl --user -u aman`
4. `aman run --config ~/.config/aman/config.json --verbose`
The diagnostic IDs and common remediation steps are documented in
[`docs/runtime-recovery.md`](docs/runtime-recovery.md).