Thales Maciel
359b5fbaf4
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.
24 lines
425 B
Markdown
24 lines
425 B
Markdown
# First-Run Review Notes
|
|
|
|
Use this file to capture the non-implementer walkthrough required to close
|
|
milestone 4.
|
|
|
|
## Review template
|
|
|
|
- Reviewer:
|
|
- Date:
|
|
- Environment:
|
|
- Entry point used:
|
|
- Did the reviewer use only the public docs? yes / no
|
|
|
|
## First-run questions or confusions
|
|
|
|
- Question:
|
|
- Where it appeared:
|
|
- How the docs or product resolved it:
|
|
|
|
## Remaining gaps
|
|
|
|
- Gap:
|
|
- Severity:
|
|
- Suggested follow-up:
|