thaloco/aman
1
Fork 0
Code Pull requests Releases Packages Activity Actions

Land milestone 4 first-run docs and media

Browse source 
Make the X11 user path visible on first contact instead of burying it under config and maintainer detail.

Rewrite the README around the supported quickstart, expected tray and dictation result, install validation, troubleshooting, and linked follow-on docs. Split deep config and developer material into separate docs, add checked-in screenshots plus a short WebM walkthrough, and add a generator so the media assets stay reproducible.

Also fix the CLI discovery gap by letting `aman --help` show the top-level command surface while keeping implicit foreground `run` behavior, and align the settings, help, and about copy with the supported service-plus-diagnostics model.

Validation: `PYTHONPATH=src python3 -m unittest tests.test_aman_cli tests.test_config_ui`; `PYTHONPATH=src python3 -m unittest discover -s tests -p 'test_*.py'`; `python3 -m py_compile src/*.py tests/*.py scripts/generate_docs_media.py`; `PYTHONPATH=src python3 -m aman --help`.

Milestone 4 stays open in the roadmap because `docs/x11-ga/first-run-review-notes.md` still needs a real non-implementer walkthrough.
This commit is contained in:
Thales Maciel 2026-03-12 18:30:34 -03:00
parent ed1b59240b
commit 359b5fbaf4
16 changed files with 788 additions and 411 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/x11-ga/04-first-run-ux-and-support-docs.md
View file

@ -22,7 +22,7 @@ Even if install and runtime reliability are strong, Aman will not feel GA until
- first launch
- choosing a microphone
- triggering the first dictation
- expected tray or notification behavior
- expected tray behavior
- expected injected text result
- Add a "validate your install" flow using `aman doctor` and `aman self-check`.
- Add screenshots for the settings window and tray menu.
@ -63,6 +63,6 @@ Even if install and runtime reliability are strong, Aman will not feel GA until
## Evidence required to close
- Updated README and linked support docs.
- Screenshots and demo artifact checked into the release or docs surface.
- Screenshots and demo artifact checked into the docs surface.
- A reviewer walk-through from someone who did not implement the docs rewrite.
- A short list of first-run questions found during review and how the docs resolved them.